.. vale off :class:`Table` ============== .. py:class:: ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Table(internalObject: Any) Bases: :py:obj:`object` Defines a Table. .. !! processed by numpydoc !! .. py:currentmodule:: Table Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~Add` - * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~Clear` - * - :py:attr:`~Contains` - * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateAndAddColumn` - Creates and adds a new column (data series) to the table. * - :py:attr:`~CreateObjRef` - CreateObjRef method. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~Equals` - Equals method. * - :py:attr:`~ExecutePropertySetViaApi` - * - :py:attr:`~GetAPIName` - Property name bound to dispId. * - :py:attr:`~GetAllProperties` - GetAllProperties method. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetDataURI` - Gets the data URI from which the tabular data was imported. * - :py:attr:`~GetEnumName` - Enum name bound to value * - :py:attr:`~GetEnumerator` - * - :py:attr:`~GetHashCode` - GetHashCode method. * - :py:attr:`~GetIconFile` - GetIconFile method. * - :py:attr:`~GetImportSettings` - Get the settings used for an import operation. * - :py:attr:`~GetLifetimeService` - GetLifetimeService method. * - :py:attr:`~GetObjectData` - GetObjectData method. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GetPath` - GetPath method. * - :py:attr:`~GetPropertyName` - GetPropertyName method. * - :py:attr:`~GetPropertyValue` - GetPropertyValue method. * - :py:attr:`~GetRow` - * - :py:attr:`~GetType` - GetType method. * - :py:attr:`~GetVisibleProperties` - GetVisibleProperties method. * - :py:attr:`~GetVisiblePropertyNames` - GetVisiblePropertyNames method. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~Import` - Import data from the provided resource into the table as specified by * - :py:attr:`~InitializeLifetimeService` - InitializeLifetimeService method. * - :py:attr:`~Insert` - * - :py:attr:`~IsPropertyEditable` - IsPropertyEditable method. * - :py:attr:`~IsPropertyVisible` - IsPropertyVisible method. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyById` - PropertyById method. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~Remove` - * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. * - :py:attr:`~ToString` - ToString method. * - :py:attr:`~TryInsertRow` - * - :py:attr:`~TryRemoveRow` - .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~APDLName` - Gets or sets the name of the Table when explicitly written to the APDL input file. * - :py:attr:`~CanRemove` - * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~ColumnNames` - * - :py:attr:`~Columns` - * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~Count` - * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~GroupingFolder` - GroupingFolder property. * - :py:attr:`~IconName` - IconName property. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~IsFixedColumnCount` - * - :py:attr:`~IsFixedRowCount` - * - :py:attr:`~IsImported` - Returns whether the Table has any imported columns. * - :py:attr:`~IsReadOnly` - * - :py:attr:`~IsStrictSizing` - Whether column add/create/import/refresh operations cannot grow the number of rows. * - :py:attr:`~Item` - Item property. * - :py:attr:`~Metadata` - * - :py:attr:`~Name` - * - :py:attr:`~ObjectId` - ObjectId property. * - :py:attr:`~ObjectState` - ObjectState property. * - :py:attr:`~ObjectTags` - ObjectTags property. * - :py:attr:`~Parent` - Parent property. * - :py:attr:`~PathType` - Gets or sets the PathType. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~RefreshImportOn` - Gets or sets the RefreshImportOn. * - :py:attr:`~RowCount` - * - :py:attr:`~SendToSolver` - Get whether the Table will be explicitly written to the APDL input file. * - :py:attr:`~SpatialCoordinateSystem` - Gets or sets the coordinate system applied to the Table’s spatial independent columns. * - :py:attr:`~State` - State property. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: APDLName :type: Optional[str] Gets or sets the name of the Table when explicitly written to the APDL input file. .. !! processed by numpydoc !! .. py:property:: CanRemove :type: Optional[bool] .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: ColumnNames :type: Optional[tuple[str]] .. py:property:: Columns :type: Optional[List[Ansys.Mechanical.Interfaces.IDataSeries]] .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: Count :type: Optional[int] .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: GroupingFolder :type: Optional[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] GroupingFolder property. .. !! processed by numpydoc !! .. py:property:: IconName :type: Optional[str] IconName property. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSTableAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: IsFixedColumnCount :type: Optional[bool] .. py:property:: IsFixedRowCount :type: Optional[bool] .. py:property:: IsImported :type: Optional[bool] Returns whether the Table has any imported columns. .. !! processed by numpydoc !! .. py:property:: IsReadOnly :type: Optional[bool] .. py:property:: IsStrictSizing :type: Optional[bool] Whether column add/create/import/refresh operations cannot grow the number of rows. will always be `true` when is `true`. When is `true`, any operation that would change the table row count will fail. This includes operations such as creating and adding a column, importing columns. .. !! processed by numpydoc !! .. py:property:: Item :type: Optional[Ansys.Mechanical.Interfaces.IDataSeries] Item property. .. !! processed by numpydoc !! .. py:property:: Metadata :type: Optional[dict[str, Any]] .. py:property:: Name :type: Optional[str] .. py:property:: ObjectId :type: Optional[int] ObjectId property. .. !! processed by numpydoc !! .. py:property:: ObjectState :type: Optional[Ansys.Mechanical.DataModel.Enums.ObjectState] ObjectState property. .. !! processed by numpydoc !! .. py:property:: ObjectTags :type: Optional[Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag]] ObjectTags property. .. !! processed by numpydoc !! .. py:property:: Parent :type: Optional[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] Parent property. .. !! processed by numpydoc !! .. py:property:: PathType :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.Common.PathType] Gets or sets the PathType. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: RefreshImportOn :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.Table.TableRefreshImportOn] Gets or sets the RefreshImportOn. .. !! processed by numpydoc !! .. py:property:: RowCount :type: Optional[int] .. py:property:: SendToSolver :type: Optional[bool] Get whether the Table will be explicitly written to the APDL input file. .. !! processed by numpydoc !! .. py:property:: SpatialCoordinateSystem :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the coordinate system applied to the Table’s spatial independent columns. .. !! processed by numpydoc !! .. py:property:: State :type: Optional[Ansys.Mechanical.DataModel.Enums.Legacy.State] State property. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: Add(dataSeries: Ansys.Mechanical.Interfaces.IDataSeries) -> None .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: Clear() -> None .. py:method:: Contains(name: str) -> bool .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateAndAddColumn(variableType: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableType, variableClassification: Ansys.Mechanical.DataModel.MechanicalEnums.Table.VariableClassification, data: Iterable, unit: str, name: str) -> Ansys.Mechanical.Interfaces.IDataSeries .. code-block:: text Creates and adds a new column (data series) to the table. If `data` is provided, the number of rows (length of `data`) must be identical to the number of rows already in the table. If `data` is not provided, the returned series will have the same number of rows as the table with default-initialized values. If there are no rows in the table and `data` is provided, this will initialize the number of rows in the table to the length of `data`. .. !! processed by numpydoc !! .. py:method:: CreateObjRef(requestedType: type) -> System.Runtime.Remoting.ObjRef CreateObjRef method. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) -> bool Equals method. .. !! processed by numpydoc !! .. py:method:: ExecutePropertySetViaApi(propertyName: str) -> bool .. py:method:: GetAPIName(dispId: int) -> str Property name bound to dispId. .. !! processed by numpydoc !! .. py:method:: GetAllProperties() -> List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper] GetAllProperties method. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetDataURI(newColumn: Ansys.ACT.Automation.Mechanical.Table.Column) -> str Gets the data URI from which the tabular data was imported. .. !! processed by numpydoc !! .. py:method:: GetEnumName(enumType: type, value: int, dispId: int) -> str Enum name bound to value .. !! processed by numpydoc !! .. py:method:: GetEnumerator() -> Iterator[Ansys.Mechanical.Interfaces.IDataSeries] .. py:method:: GetHashCode() -> int GetHashCode method. .. !! processed by numpydoc !! .. py:method:: GetIconFile() -> System.Byte GetIconFile method. .. !! processed by numpydoc !! .. py:method:: GetImportSettings(newColumn: Ansys.ACT.Automation.Mechanical.Table.Column) -> Ansys.Mechanical.Table.ImportSettingsBase Get the settings used for an import operation. .. !! processed by numpydoc !! .. py:method:: GetLifetimeService() -> Any GetLifetimeService method. .. !! processed by numpydoc !! .. py:method:: GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) -> None GetObjectData method. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GetPath() -> str GetPath method. .. !! processed by numpydoc !! .. py:method:: GetPropertyName(dispId: int) -> str GetPropertyName method. .. !! processed by numpydoc !! .. py:method:: GetPropertyValue(name: str) -> Any GetPropertyValue method. .. !! processed by numpydoc !! .. py:method:: GetRow(rowIndex: int) -> Iterable .. py:method:: GetType() -> type GetType method. .. !! processed by numpydoc !! .. py:method:: GetVisibleProperties() -> List[System.Reflection.PropertyInfo] GetVisibleProperties method. .. !! processed by numpydoc !! .. py:method:: GetVisiblePropertyNames() -> List[str] GetVisiblePropertyNames method. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: Import(dataURI: str, format: Ansys.Mechanical.DataModel.MechanicalEnums.Table.ImportFormat, settings: Ansys.Mechanical.Table.ImportSettingsBase) -> List[Ansys.Mechanical.Interfaces.IDataSeries] .. code-block:: text Import data from the provided resource into the table as specified by format and settings. The column definitions in settings will be used to define the variable type for each column. If the table already contains a variable type, that column will be overwritten by the new definition. When is true, will verify that the row count of imported data are equivalent to the existing table row count. The operation will fail if there is a length mismatch. Conversely, when is false, a Mechanical warning message will be issued when any of the data sources are different from each other or the table. If all the arguments are `null` (Python: `None`) then the stored values will be used, essentially re-syncing the table data to the external sources. .. !! processed by numpydoc !! .. py:method:: InitializeLifetimeService() -> Any InitializeLifetimeService method. .. !! processed by numpydoc !! .. py:method:: Insert(columnIndex: int, dataSeries: Ansys.Mechanical.Interfaces.IDataSeries) -> None .. py:method:: IsPropertyEditable(dispId: int) -> bool IsPropertyEditable method. .. !! processed by numpydoc !! .. py:method:: IsPropertyVisible(dispId: int) -> bool IsPropertyVisible method. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: PropertyById(dispId: int) -> Ansys.ACT.Automation.Mechanical.Property PropertyById method. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: Remove(key: Any) -> None .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: ToString() -> str ToString method. .. !! processed by numpydoc !! .. py:method:: TryInsertRow(rowIndex: int, values: Iterable) -> bool .. py:method:: TryRemoveRow(rowIndex: int) -> bool .. vale on