`Chart`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Chart#

Bases: object

Defines a Chart.

Overview#

Methods

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

Properties

`OutlineSelection`	Gets or sets the OutlineSelection.
`XAxis`	Use to control the X Axis property of the chart.
`InternalObject`	Gets the internal object. For advanced usage only.
`Caption`	Gets or sets the Caption.
`XAxisLabel`	Gets or sets the XAxisLabel.
`YAxisLabel`	Gets or sets the YAxisLabel.
`Gridlines`	Gets or sets the Gridlines.
`ModalDisplayType`	Gets or sets the ModalDisplayType.
`PlotStyle`	Gets or sets the PlotStyle.
`Content`	Gets or sets the Content.
`Scale`	Gets or sets the Scale.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property Chart.OutlineSelection: System.Collections.Generic.IEnumerable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets or sets the OutlineSelection.

property Chart.XAxis: Ansys.ACT.Automation.Mechanical.ChartXAxis | None: Use to control the X Axis property of the chart.

property Chart.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSChartAuto | None: Gets the internal object. For advanced usage only.

property Chart.Caption: System.String | None: Gets or sets the Caption.

property Chart.XAxisLabel: System.String | None: Gets or sets the XAxisLabel.

property Chart.YAxisLabel: System.String | None: Gets or sets the YAxisLabel.

property Chart.Gridlines: Ansys.Mechanical.DataModel.Enums.ChartGridlines | None: Gets or sets the Gridlines.

property Chart.ModalDisplayType: Ansys.Mechanical.DataModel.Enums.ChartModalType | None: Gets or sets the ModalDisplayType.

property Chart.PlotStyle: Ansys.Mechanical.DataModel.Enums.ChartPlotStyle | None: Gets or sets the PlotStyle.

property Chart.Content: Ansys.Mechanical.DataModel.Enums.ChartReportType | None: Gets or sets the Content.

property Chart.Scale: Ansys.Mechanical.DataModel.Enums.ChartScale | None: Gets or sets the Scale.

property Chart.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property Chart.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property Chart.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property Chart.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property Chart.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property Chart.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property Chart.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

Chart.Delete() → System.Void: Run the Delete action.

Chart.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

Chart.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

Chart.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

Chart.AddImage(filePath: System.String) → 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.Activate() → System.Void: Activate the current object.

Chart.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

Chart.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

Chart.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

Chart.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

Chart.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

Chart.PropertyByAPIName(name: System.String) → 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.

Chart.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

Chart.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

Chart.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.