.. vale off :class:`Table` ============== .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Table 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:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :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:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :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:`~GetImportSettings` - Get the settings used for an import operation. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~Import` - .. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. .. 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:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~IsStrictSizing` - Whether column add/create/import/refresh operations cannot grow the number of rows. * - :py:attr:`~PathType` - Gets or sets the PathType. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~RefreshImportOn` - Controls when the imported file should be refreshed. * - :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:`~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:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. 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:: 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:: IsStrictSizing :type: Optional[bool] Whether column add/create/import/refresh operations cannot grow the number of rows. .. !! 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] Controls when the imported file should be refreshed. .. !! processed by numpydoc !! .. 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:: 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:: 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:: 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 Creates and adds a new column (data series) to the table. .. !! 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:: 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:: 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:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! 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] .. !! 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:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on