Table
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Table#
Bases:
object
Defines a Table.
Overview#
|
Creates and adds a new column (data series) to the table. |
|
Gets the data URI from which the tabular data was imported. |
|
Get the settings used for an import operation. |
|
|
|
Gets the list of children, filtered by type. |
|
Gets the list of children, filtered by type. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Activate the current object. |
|
Copies all visible properties from this object to another. |
|
Creates a copy of the current DataModelObject. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its unique name. |
|
Get a property by its API name. |
|
Creates a new parameter for a Property. |
|
Gets the parameter corresponding to the given property. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Whether column add/create/import/refresh operations cannot grow the number of rows. |
|
Controls when the imported file should be refreshed. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the name of the Table when explicitly written to the APDL input file. |
|
Gets or sets the PathType. |
|
Get whether the Table will be explicitly written to the APDL input file. |
|
Gets or sets the coordinate system applied to the Table’s spatial independent columns. |
|
Gets the current DataModelObject’s category. |
|
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets the list of associated figures. |
|
Gets the list of associated images. |
|
Gets the internal object. For advanced usage only. |
|
Gets the list of properties for this object. |
|
Gets the list of properties that are visible for this object. |
Property detail#
- property Table.IsStrictSizing: System.Boolean | None
Whether column add/create/import/refresh operations cannot grow the number of rows.
- property Table.RefreshImportOn: Ansys.Mechanical.DataModel.MechanicalEnums.Table.TableRefreshImportOn | None
Controls when the imported file should be refreshed.
- property Table.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSTableAuto | None
Gets the internal object. For advanced usage only.
- property Table.APDLName: System.String | None
Gets or sets the name of the Table when explicitly written to the APDL input file.
- property Table.PathType: Ansys.Mechanical.DataModel.MechanicalEnums.Common.PathType | None
Gets or sets the PathType.
- property Table.SendToSolver: System.Boolean | None
Get whether the Table will be explicitly written to the APDL input file.
- property Table.SpatialCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets or sets the coordinate system applied to the Table’s spatial independent columns.
- property Table.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
- property Table.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
- property Table.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
- property Table.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
- property Table.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
- property Table.InternalObject: System.Object | None
Gets the internal object. For advanced usage only.
- property Table.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
- property Table.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail#
- Table.CreateAndAddColumn(variableType: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableType, variableClassification: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableClassification, data: System.Collections.IEnumerable, unit: System.String, name: System.String) Ansys.Mechanical.Interfaces.IDataSeries
Creates and adds a new column (data series) to the table.
- Table.GetDataURI(newColumn: Ansys.ACT.Automation.Mechanical.Table.Column) System.String
Gets the data URI from which the tabular data was imported.
- Table.GetImportSettings(newColumn: Ansys.ACT.Automation.Mechanical.Table.Column) Ansys.Mechanical.Table.ImportSettingsBase
Get the settings used for an import operation.
- Table.Import(dataURI: System.String, format: Ansys.Mechanical.DataModel.MechanicalEnums.Table.ImportFormat, settings: Ansys.Mechanical.Table.ImportSettingsBase) System.Collections.Generic.IList[Ansys.Mechanical.Interfaces.IDataSeries]
- Table.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) System.Collections.Generic.IList[ChildrenType]
Gets the list of children, filtered by type.
- Table.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.
- Table.AddComment() Ansys.ACT.Automation.Mechanical.Comment
Creates a new child Comment.
- Table.AddFigure() Ansys.ACT.Automation.Mechanical.Figure
Creates a new child Figure.
- Table.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.
- Table.Activate() System.Void
Activate the current object.
- Table.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) System.Void
Copies all visible properties from this object to another.
- Table.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject
Creates a copy of the current DataModelObject.
- Table.GroupAllSimilarChildren() System.Void
Run the GroupAllSimilarChildren action.
- Table.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder
Run the GroupSimilarObjects action.
- Table.PropertyByName(name: System.String) Ansys.ACT.Automation.Mechanical.Property
Get a property by its unique name.
- Table.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.
- Table.CreateParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Creates a new parameter for a Property.
- Table.GetParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Gets the parameter corresponding to the given property.
- Table.RemoveParameter(propName: System.String) System.Void
Removes the parameter from the parameter set corresponding to the given property.