Class: Table

Defines a Table.

Implemented types

Methods

Name Description
Activate() Activate the current object.
Add(IDataSeries) Add a new column to the data table.
AddComment() Creates a new child Comment.
AddFigure() Creates a new child Figure.
AddImage(String) 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.
Clear() Drops all columns from the data table.
Contains(String) Returns whether the data table contains a column with the specified name.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateAndAddColumn(VariableType, VariableClassification, IEnumerable, String, String) 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`.
CreateParameter(String) Creates a new parameter for a Property.
Duplicate() Creates a copy of the current DataModelObject.
GetDataURI(Column)
GetImportSettings(Column)
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GetRow(Int32)
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
Import(String, ImportFormat, ImportSettingsBase) Import data from the provided resource into the table as specified by and . The column definitions in 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.
Insert(Int32, IDataSeries) Insert a column at the specified index.
PropertyByAPIName(String) 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.
PropertyByName(String) Get a property by its unique name.
Remove(Object) Removes the specified column. If is an , it will be interpreted as an index. If is a , it will be interpreted as a column name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
TryInsertRow(Int32, IEnumerable) Try to insert the values at the specified row index.
TryRemoveRow(Int32) Try to remove the specified row.

Properties

Name Description
APDLName Gets or sets the name of the Table when explicitly written to the APDL input file.
ColumnNames
Columns Explicitly get the columns of the data table.
Comments Gets the list of associated comments.
Count Gets the number of columns in the table.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
IsFixedColumnCount Get whether additional columns can be added or removed from the contained .
IsFixedRowCount Get whether additional rows can be added or removed from the contained .
IsReadOnly Gets whether the data table is read-only.
IsStrictSizing 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.
Item
Metadata Gets or set a dictionary with additional information that may be useful to understanding the context of data in the table.
Name Gets the name of the object.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
Parent Gets the parent object.
PathType Gets or sets the PathType.
Properties Gets the list of properties for this object.
RefreshImportOn Gets or sets the RefreshImportOn.
RowCount
SendToSolver Get whether the Table will be explicitly written to the APDL input file.
SpatialCoordinateSystem Gets or sets the coordinate system applied to the Table’s spatial independent columns.
VisibleProperties Gets the list of properties that are visible for this object.