Chart
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Chart#
Bases:
object
Defines a Chart.
Overview#
Activate the current object. |
|
Creates a new child Comment. |
|
Creates a new child Image. |
|
Copies all visible properties from this object to another. |
|
Creates a new parameter for a Property. |
|
Run the Delete action. |
|
Creates a copy of the current DataModelObject. |
|
Gets the list of children, filtered by type. |
|
Gets the parameter corresponding to the given property. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its API name. |
|
Get a property by its unique name. |
|
Removes the parameter from the parameter set corresponding to the given property. |
Gets or sets the Caption. |
|
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets or sets the Content. |
|
Gets the current DataModelObject's category. |
|
Gets or sets the Gridlines. |
|
Gets the list of associated images. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the ModalDisplayType. |
|
Gets or sets the OutlineSelection. |
|
Gets or sets the PlotStyle. |
|
Gets the list of properties for this object. |
|
Gets or sets the Scale. |
|
Gets the list of properties that are visible for this object. |
|
Use to control the X Axis property of the chart. |
|
Gets or sets the XAxisLabel. |
|
Gets or sets the YAxisLabel. |
Property detail#
- property Chart.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#
Gets the list of children.
- property Chart.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#
Gets the list of associated comments.
- property Chart.Content: Ansys.Mechanical.DataModel.Enums.ChartReportType | None#
Gets or sets the Content.
- property Chart.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#
Gets the current DataModelObject's category.
- property Chart.Gridlines: Ansys.Mechanical.DataModel.Enums.ChartGridlines | None#
Gets or sets the Gridlines.
- property Chart.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#
Gets the list of associated images.
- property Chart.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSChartAuto | None#
Gets the internal object. For advanced usage only.
- property Chart.ModalDisplayType: Ansys.Mechanical.DataModel.Enums.ChartModalType | None#
Gets or sets the ModalDisplayType.
- property Chart.OutlineSelection: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#
Gets or sets the OutlineSelection.
- property Chart.PlotStyle: Ansys.Mechanical.DataModel.Enums.ChartPlotStyle | None#
Gets or sets the PlotStyle.
- property Chart.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
Gets the list of properties for this object.
- property Chart.Scale: Ansys.Mechanical.DataModel.Enums.ChartScale | None#
Gets or sets the Scale.
- property Chart.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#
Gets the list of properties that are visible for this object.
- property Chart.XAxis: Ansys.ACT.Automation.Mechanical.ChartXAxis | None#
Use to control the X Axis property of the chart.
Method detail#
- Chart.AddComment() Ansys.ACT.Automation.Mechanical.Comment #
Creates a new child Comment.
- Chart.AddImage(filePath: str) Ansys.ACT.Automation.Mechanical.Image #
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.
- Chart.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None #
Copies all visible properties from this object to another.
- Chart.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Creates a new parameter for a Property.
- Chart.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject #
Creates a copy of the current DataModelObject.
- Chart.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType] #
Gets the list of children, filtered by type.
- Chart.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter #
Gets the parameter corresponding to the given property.
- Chart.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder #
Run the GroupSimilarObjects action.
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.