Chart

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Chart(internalObject: Any)

Bases: object

Defines a Chart.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddImage	Creates a new child Image.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Caption	Gets or sets the Caption.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
Content	Gets or sets the Content.
DataModelObjectCategory	Gets the current DataModelObject's category.
Gridlines	Gets or sets the Gridlines.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
IndependentAxis	Gets or sets the IndependentAxis.
InternalObject	Gets the internal object. For advanced usage only.
ModalDisplayType	Gets or sets the ModalDisplayType.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
OutlineSelection	Gets or sets the OutlineSelection.
Parent	Parent property.
PlotStyle	Gets or sets the PlotStyle.
Properties	Gets the list of properties for this object.
Scale	Gets or sets the Scale.
State	State property.
VisibleProperties	Gets the list of properties that are visible for this object.
XAxis	Use to control the X Axis property of the chart.
XAxisLabel	Gets or sets the XAxisLabel.
YAxisLabel	Gets or sets the YAxisLabel.

Property detail

property Chart.AttachedRefs: List[int] | None

AttachedRefs property.

property Chart.Caption: str | None

Gets or sets the Caption.

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

Gets the list of children.

property Chart.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property Chart.IconName: str | None

IconName property.

property Chart.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Chart.IndependentAxis: int | None

Gets or sets the IndependentAxis.

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.Name: str | None

Name property.

property Chart.ObjectId: int | None

ObjectId property.

property Chart.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property Chart.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property Chart.OutlineSelection: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets or sets the OutlineSelection.

property Chart.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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.

property Chart.XAxisLabel: str | None

Gets or sets the XAxisLabel.

property Chart.YAxisLabel: str | None

Gets or sets the YAxisLabel.

Method detail

Chart.Activate() → None

Activate the current object.

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.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

Chart.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

Chart.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

Chart.GetAPIName(dispId: int) → str

Property name bound to dispId.

Chart.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

Chart.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

Chart.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

Chart.GetHashCode() → int

GetHashCode method.

Chart.GetIconFile() → System.Byte

GetIconFile method.

Chart.GetLifetimeService() → Any

GetLifetimeService method.

Chart.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

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

Gets the parameter corresponding to the given property.

Chart.GetPath() → str

GetPath method.

Chart.GetPropertyName(dispId: int) → str

GetPropertyName method.

Chart.GetPropertyValue(name: str) → Any

GetPropertyValue method.

Chart.GetType() → type

GetType method.

Chart.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

Chart.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Chart.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

Chart.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Chart.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Chart.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

Chart.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.

Chart.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

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

Get a property by its unique name.

Chart.RemoveParameter(propName: str) → None

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

Chart.ToString() → str

ToString method.