Figure

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Figure

Bases: object

Defines a Figure.

Overview

Methods

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

Properties

Children	Gets the list of children.
Comments	Gets the list of associated comments.
DataModelObjectCategory	Gets the current DataModelObject's category.
InternalObject	Gets the internal object. For advanced usage only.
Properties	Gets the list of properties for this object.
Text	Gets or sets the Text.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property Figure.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Figure.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Figure.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

property Figure.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSFigureAuto | None

Gets the internal object. For advanced usage only.

property Figure.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Figure.Text: str | None

Gets or sets the Text.

property Figure.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

Figure.Activate() → None

Activate the current object.

Figure.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Figure.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

Figure.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

Figure.Delete() → None

Run the Delete action.

Figure.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

Figure.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

Figure.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Figure.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

Figure.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

Figure.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

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.

Figure.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

Figure.RemoveParameter(propName: str) → None

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