LineChart2D

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.LineChart2D

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.
CopyTo	Copies all visible properties from this object to another.
CreateParameter	Creates a new parameter for a Property.
Duplicate	Creates a copy of the current DataModelObject.
GetChildren	Gets the list of children, filtered by type.
GetIndependentVariable	Returns the Dataset2D object chosen as the Independent Variable of the Chart.
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.
SetIndependentVariable	Sets the Dataset2D object chosen as the Independent Variable of the Chart.
Update	Fetches the latest results from the modified Source object(s)

Properties

Chart	Gets the chart object on Line Chart.
Children	Gets the list of children.
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.
Source	Gets or sets source objects.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property LineChart2D.Chart: Ansys.ACT.Interfaces.Mechanical.IChart | 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.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

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

Gets the internal object. For advanced usage only.

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.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.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

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.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

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

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

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

Gets the parameter corresponding to the given property.

LineChart2D.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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