LineChart2D

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

Bases: object

An object in the Tree to display data imported from various source objects under “Solution” or from files. It utilizes Ansys.Mechanical.DataModel.Utilities.Charts.Chart for displaying the imported data and provides users with the flexibility to modify the data to some extent (eg. deleting, hiding/showing, modifying their display and applying operations on them).

Overview

Methods

Activate	Activate the current object.
CanDoUpdateOutdatedChartSources	CanDoUpdateOutdatedChartSources method.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChartAxisDisplayUnit	GetChartAxisDisplayUnit method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetGraphInteractionEvent	GetGraphInteractionEvent method.
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetIndependentVariable	Returns the Dataset2D object chosen as the Independent Variable of the Chart.
GetLifetimeService	GetLifetimeService method.
GetNumberOfCharts	GetNumberOfCharts 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.
PromoteXAxisChart	PromoteXAxisChart 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.
SetGraphInteractionEvent	SetGraphInteractionEvent method.
SetIndependentVariable	Sets the Dataset2D object chosen as the Independent Variable of the Chart.
ToString	ToString method.
Update	Fetches the latest results from the modified Source object(s)

Properties

AttachedRefs	AttachedRefs property.
Chart	Gets the chart object on Line Chart.
Charts	Gets the chart object on Line Chart.
Children	Gets the list of children.
ClsId	ClsId property.
DataModelObjectCategory	Gets the current DataModelObject's category.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
InternalObject	Gets the internal object. For advanced usage only.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
Source	Gets or sets source objects.
State	State property.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property LineChart2D.AttachedRefs: List[int] | None

AttachedRefs property.

property LineChart2D.Chart: Ansys.ACT.Interfaces.Mechanical.IChart | None

Gets the chart object on Line Chart.

property LineChart2D.Charts: List[Ansys.ACT.Interfaces.Mechanical.IReadOnlyChart] | None

Gets the chart object on Line Chart.

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

Gets the list of children.

property LineChart2D.ClsId: int | None

ClsId property.

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

Gets the current DataModelObject's category.

property LineChart2D.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property LineChart2D.IconName: str | None

IconName property.

property LineChart2D.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSBasicResultChartAuto | None

Gets the internal object. For advanced usage only.

property LineChart2D.Name: str | None

Name property.

property LineChart2D.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

Gets the list of properties for this object.

property LineChart2D.Source: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets or sets source objects. When setting, all datasets are copied from the specified sources and added to the chart object owned by LineChart2D. We will ignore unsupported objects and import the ones that are supported.

property LineChart2D.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property LineChart2D.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

Method detail

LineChart2D.Activate() → None

Activate the current object.

LineChart2D.CanDoUpdateOutdatedChartSources() → bool

CanDoUpdateOutdatedChartSources method.

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

Copies all visible properties from this object to another.

LineChart2D.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

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

Creates a new parameter for a Property.

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

Creates a copy of the current DataModelObject.

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

Equals method.

LineChart2D.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

LineChart2D.GetChartAxisDisplayUnit(chart_idx: int, axis_id: int) → str

GetChartAxisDisplayUnit method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

LineChart2D.GetGraphInteractionEvent(ppEventArgs: Any, chartIndex: int) → None

GetGraphInteractionEvent method.

LineChart2D.GetHashCode() → int

GetHashCode method.

LineChart2D.GetIconFile() → System.Byte

GetIconFile method.

LineChart2D.GetIndependentVariable() → Ansys.Mechanical.DataModel.Utilities.Dataset.Dataset2D

Returns the Dataset2D object chosen as the Independent Variable of the Chart.

LineChart2D.GetLifetimeService() → Any

GetLifetimeService method.

LineChart2D.GetNumberOfCharts() → int

GetNumberOfCharts method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

LineChart2D.GetPath() → str

GetPath method.

LineChart2D.GetPropertyName(dispId: int) → str

GetPropertyName method.

LineChart2D.GetPropertyValue(name: str) → Any

GetPropertyValue method.

LineChart2D.GetType() → type

GetType method.

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

GetVisibleProperties method.

LineChart2D.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

LineChart2D.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

LineChart2D.InitializeLifetimeService() → Any

InitializeLifetimeService method.

LineChart2D.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

LineChart2D.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

LineChart2D.PromoteXAxisChart() → None

PromoteXAxisChart method.

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

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

PropertyById method.

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

Get a property by its unique name.

LineChart2D.RemoveParameter(propName: str) → None

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

LineChart2D.SetGraphInteractionEvent(pEventArgs: Any, chartIndex: int) → None

SetGraphInteractionEvent method.

LineChart2D.SetIndependentVariable(input_dataset: Ansys.Mechanical.DataModel.Utilities.Dataset.Dataset2D) → None

Sets the Dataset2D object chosen as the Independent Variable of the Chart.

Chart data are constructed using the chosen Dataset2D's Y-values as the Independent Variable and
the Y-values from the other datasets as the Dependent Variable. Only Y-values at intersecting X-values from the datasets are picked;
no interpolation is performed for missing X-values.

An input of "None" returns the chart to its original state.
If any dataset contains negative values that conflict with the Logarithmic setting of a chart axis, then Logarithmic for that axis is disabled.
An InvalidOperationException is thrown if any Dataset on the Chart is not strictly monotonic.
An ArgumentException is thrown if the chosen Independent Variable is not a Dataset on the Chart.

LineChart2D.ToString() → str

ToString method.

LineChart2D.Update() → None

Fetches the latest results from the modified Source object(s)
and replaces the Datasets originally imported from the respective Source(s).
If any dataset contains negative values that conflict with the Logarithmic setting of a chart axis, then Logarithmic for that axis is disabled.
If the revised datasets from the Update operation conflict with the existing X-axis quantity on the chart,
the Update operation is aborted with an InvalidOperationException and the old data is restored.