## On this page

  

 

 # `Displacement`

 Last update: 09.03.2026 

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

#### *class* Ansys.ACT.Automation.Mechanical.BoundaryConditions.Displacement

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

Defines a Displacement.

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

## Overview

### Methods

NameDescription[`Activate`](#Displacement.Activate)Activate the current object.[`AddComment`](#Displacement.AddComment)Creates a new child Comment.[`AddFigure`](#Displacement.AddFigure)Creates a new child Figure.[`AddImage`](#Displacement.AddImage)Creates a new child Image.[`CopyTo`](#Displacement.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#Displacement.CreateParameter)Creates a new parameter for a Property.[`Delete`](#Displacement.Delete)Run the Delete action.[`Duplicate`](#Displacement.Duplicate)Creates a copy of the current DataModelObject.[`GetActivateAtLoadStep`](#Displacement.GetActivateAtLoadStep)Gets whether the displacement is active at the specified load step.[`GetChildren`](#Displacement.GetChildren)Gets the list of children, filtered by type.[`GetComponentActivateAtLoadStep`](#Displacement.GetComponentActivateAtLoadStep)GetComponentActivateAtLoadStep method.[`GetParameter`](#Displacement.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#Displacement.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#Displacement.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PromoteToNamedSelection`](#Displacement.PromoteToNamedSelection)Run the PromoteToNamedSelection action.[`PropertyByAPIName`](#Displacement.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#Displacement.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#Displacement.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.[`SetActivateAtLoadStep`](#Displacement.SetActivateAtLoadStep)Sets whether the displacement is active at the specified load step.[`SetComponentActivateAtLoadStep`](#Displacement.SetComponentActivateAtLoadStep)SetComponentActivateAtLoadStep method.### Properties

NameDescription[`AbsoluteResult`](#Displacement.AbsoluteResult)Gets or sets the AbsoluteResult.[`BaseExcitation`](#Displacement.BaseExcitation)Gets or sets the BaseExcitation.[`BoundaryCondition`](#Displacement.BoundaryCondition)Gets or sets the BoundaryCondition.[`Children`](#Displacement.Children)Gets the list of children.[`Comments`](#Displacement.Comments)Gets the list of associated comments.[`CoordinateSystem`](#Displacement.CoordinateSystem)Gets or sets the CoordinateSystem.[`DataModelObjectCategory`](#Displacement.DataModelObjectCategory)Gets the current DataModelObject's category.[`DefineBy`](#Displacement.DefineBy)Gets or sets the DefineBy.[`Direction`](#Displacement.Direction)Gets or sets the Direction.[`Distance`](#Displacement.Distance)Gets the Distance.[`DynamicRelaxationBehavior`](#Displacement.DynamicRelaxationBehavior)Gets or sets the DynamicRelaxationBehavior.[`Figures`](#Displacement.Figures)Gets the list of associated figures.[`GraphControlsXAxis`](#Displacement.GraphControlsXAxis)Gets or sets the GraphControlsXAxis.[`Images`](#Displacement.Images)Gets the list of associated images.[`IndependentVariable`](#Displacement.IndependentVariable)Gets or sets the IndependentVariable.[`InternalObject`](#Displacement.InternalObject)Gets the internal object. For advanced usage only.[`Location`](#Displacement.Location)Gets or sets the Location.[`MagnitudeImag`](#Displacement.MagnitudeImag)Gets the MagnitudeImag.[`NumberOfSegments`](#Displacement.NumberOfSegments)Gets or sets the NumberOfSegments.[`PhaseAngle`](#Displacement.PhaseAngle)Gets the PhaseAngle.[`Properties`](#Displacement.Properties)Gets the list of properties for this object.[`RangeMaximum`](#Displacement.RangeMaximum)Gets or sets the RangeMaximum.[`RangeMinimum`](#Displacement.RangeMinimum)Gets or sets the RangeMinimum.[`ReadOnly`](#Displacement.ReadOnly)Gets or sets the ReadOnly.[`ReverseDirectionForInverseSteps`](#Displacement.ReverseDirectionForInverseSteps)Gets or sets the ReverseDirectionForInverseSteps.[`RpmSelection`](#Displacement.RpmSelection)Gets or sets the RPMSelection.[`SharedRefBody`](#Displacement.SharedRefBody)Gets or sets the SharedRefBody.[`StepSelection`](#Displacement.StepSelection)Gets or sets the StepSelection.[`StepVarying`](#Displacement.StepVarying)Gets or sets the StepVarying.[`Suppressed`](#Displacement.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#Displacement.VisibleProperties)Gets the list of properties that are visible for this object.[`XComponent`](#Displacement.XComponent)Gets the XComponent.[`XComponentImag`](#Displacement.XComponentImag)Gets the XComponentImag.[`XPhaseAngle`](#Displacement.XPhaseAngle)Gets the XPhaseAngle.[`XYZFunctionCoordinateSystem`](#Displacement.XYZFunctionCoordinateSystem)Gets or sets the XYZFunctionCoordinateSystem.[`YComponent`](#Displacement.YComponent)Gets the YComponent.[`YComponentImag`](#Displacement.YComponentImag)Gets the YComponentImag.[`YPhaseAngle`](#Displacement.YPhaseAngle)Gets the YPhaseAngle.[`ZComponent`](#Displacement.ZComponent)Gets the ZComponent.[`ZComponentImag`](#Displacement.ZComponentImag)Gets the ZComponentImag.[`ZPhaseAngle`](#Displacement.ZPhaseAngle)Gets the ZPhaseAngle.<a id="property-detail"></a>

## Property detail

<a id="Displacement.AbsoluteResult"></a>

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

Gets or sets the AbsoluteResult.

<a id="Displacement.BaseExcitation"></a>

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

Gets or sets the BaseExcitation.

<a id="Displacement.BoundaryCondition"></a>

### *property* Displacement.BoundaryCondition *: Any | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BoundaryCondition.

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

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

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

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

Gets or sets the CoordinateSystem.

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

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

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

Gets or sets the DefineBy.

<a id="Displacement.Direction"></a>

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

Gets or sets the Direction.

<a id="Displacement.Distance"></a>

### *property* Displacement.Distance *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Distance.

<a id="Displacement.DynamicRelaxationBehavior"></a>

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

Gets or sets the DynamicRelaxationBehavior.

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

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

Gets the list of associated figures.

<a id="Displacement.GraphControlsXAxis"></a>

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

Gets or sets the GraphControlsXAxis.

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

### *property* Displacement.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../Image.md#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="Displacement.IndependentVariable"></a>

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

Gets or sets the IndependentVariable.

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

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

Gets the internal object. For advanced usage only.

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

### *property* Displacement.Location *: [Ansys.ACT.Interfaces.Common.ISelectionInfo](../../../Interfaces/Common/ISelectionInfo.md#ansys.mechanical.stubs.v261.Ansys.ACT.Interfaces.Common.ISelectionInfo) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

<a id="Displacement.MagnitudeImag"></a>

### *property* Displacement.MagnitudeImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MagnitudeImag.

<a id="Displacement.NumberOfSegments"></a>

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

Gets or sets the NumberOfSegments.

<a id="Displacement.PhaseAngle"></a>

### *property* Displacement.PhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the PhaseAngle.

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

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

### *property* Displacement.RangeMaximum *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v261.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMaximum.

<a id="Displacement.RangeMinimum"></a>

### *property* Displacement.RangeMinimum *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v261.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RangeMinimum.

<a id="Displacement.ReadOnly"></a>

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

Gets or sets the ReadOnly.

<a id="Displacement.ReverseDirectionForInverseSteps"></a>

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

Gets or sets the ReverseDirectionForInverseSteps.

<a id="Displacement.RpmSelection"></a>

### *property* Displacement.RpmSelection *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v261.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RPMSelection.

<a id="Displacement.SharedRefBody"></a>

### *property* Displacement.SharedRefBody *: [Ansys.ACT.Automation.Mechanical.Body](../Body.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Body) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SharedRefBody.

<a id="Displacement.StepSelection"></a>

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

Gets or sets the StepSelection.

<a id="Displacement.StepVarying"></a>

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

Gets or sets the StepVarying.

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

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

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

### *property* Displacement.XComponent *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XComponent.

<a id="Displacement.XComponentImag"></a>

### *property* Displacement.XComponentImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XComponentImag.

<a id="Displacement.XPhaseAngle"></a>

### *property* Displacement.XPhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XPhaseAngle.

<a id="Displacement.XYZFunctionCoordinateSystem"></a>

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

Gets or sets the XYZFunctionCoordinateSystem.

<a id="Displacement.YComponent"></a>

### *property* Displacement.YComponent *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YComponent.

<a id="Displacement.YComponentImag"></a>

### *property* Displacement.YComponentImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YComponentImag.

<a id="Displacement.YPhaseAngle"></a>

### *property* Displacement.YPhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YPhaseAngle.

<a id="Displacement.ZComponent"></a>

### *property* Displacement.ZComponent *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZComponent.

<a id="Displacement.ZComponentImag"></a>

### *property* Displacement.ZComponentImag *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZComponentImag.

<a id="Displacement.ZPhaseAngle"></a>

### *property* Displacement.ZPhaseAngle *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v261.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZPhaseAngle.

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

## Method detail

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

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

Activate the current object.

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

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

Creates a new child Comment.

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

### Displacement.AddFigure() → [Ansys.ACT.Automation.Mechanical.Figure](../Figure.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Figure)

Creates a new child Figure.

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

### Displacement.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [Ansys.ACT.Automation.Mechanical.Image](../Image.md#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="Displacement.CopyTo"></a>

### Displacement.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="Displacement.CreateParameter"></a>

### Displacement.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="Displacement.Delete"></a>

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

Run the Delete action.

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

### Displacement.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="Displacement.GetActivateAtLoadStep"></a>

### Displacement.GetActivateAtLoadStep(stepNumber: [int](https://docs.python.org/3/library/functions.html#int)) → [bool](https://docs.python.org/3/library/functions.html#bool)

Gets whether the displacement is active at the specified load step.

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

### Displacement.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="Displacement.GetComponentActivateAtLoadStep"></a>

### Displacement.GetComponentActivateAtLoadStep(component: [str](https://docs.python.org/3/library/stdtypes.html#str), stepNumber: [int](https://docs.python.org/3/library/functions.html#int)) → [bool](https://docs.python.org/3/library/functions.html#bool)

GetComponentActivateAtLoadStep method.

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

### Displacement.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="Displacement.GroupAllSimilarChildren"></a>

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

Run the GroupAllSimilarChildren action.

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

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

Run the GroupSimilarObjects action.

<a id="Displacement.PromoteToNamedSelection"></a>

### Displacement.PromoteToNamedSelection() → Iterable\[[Ansys.ACT.Automation.Mechanical.NamedSelection](../NamedSelection.md#ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.NamedSelection)\]

Run the PromoteToNamedSelection action.

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

### Displacement.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="Displacement.PropertyByName"></a>

### Displacement.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="Displacement.RemoveParameter"></a>

### Displacement.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.

<a id="Displacement.SetActivateAtLoadStep"></a>

### Displacement.SetActivateAtLoadStep(stepNumber: [int](https://docs.python.org/3/library/functions.html#int), bActive: [bool](https://docs.python.org/3/library/functions.html#bool)) → [None](https://docs.python.org/3/library/constants.html#None)

Sets whether the displacement is active at the specified load step.

<a id="Displacement.SetComponentActivateAtLoadStep"></a>

### Displacement.SetComponentActivateAtLoadStep(component: [str](https://docs.python.org/3/library/stdtypes.html#str), stepNumber: [int](https://docs.python.org/3/library/functions.html#int), bActive: [bool](https://docs.python.org/3/library/functions.html#bool)) → [None](https://docs.python.org/3/library/constants.html#None)

SetComponentActivateAtLoadStep method.