Skip to main content

Mechanical scripting interface

LineChart2D

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.LineChart2D

Bases: object

Defines a LineChart2D.

Overview

Methods

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

Properties

Name Description
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.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Activate the current object.

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

Copies all visible properties from this object to another.

LineChart2D.CreateParameter(propName: str)

Creates a new parameter for a Property.

LineChart2D.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

LineChart2D.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

LineChart2D.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

LineChart2D.GroupSimilarObjects()

Run the GroupSimilarObjects action.

LineChart2D.PropertyByAPIName(name: str)

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)

Get a property by its unique name.

LineChart2D.RemoveParameter(propName: str)

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