IDataTable

class ansys.mechanical.stubs.v242.Ansys.Mechanical.Interfaces.IDataTable

Bases: object

Overview

Methods

Add	Add a new column to the data table.
Clear	Drops all columns from the data table.
Contains	Returns whether the data table contains a column with the specified name.
GetRow
Insert	Insert a column at the specified index.
Remove	Removes the specified column. If the specifier of the column to remove is an T:System.Int32, it will
TryInsertRow	Try to insert the values at the specified row index.
TryRemoveRow	Try to remove the specified row.

Properties

ColumnNames
Columns	Explicitly get the columns of the data table.
Count	Gets the number of columns in the table.
IsFixedColumnCount	Get whether additional columns can be added or removed from the contained T:Ansys.Mechanical.Interfaces.IDataSeries.
IsFixedRowCount	Get whether additional rows can be added or removed from the contained
IsReadOnly	Gets whether the data table is read-only.
Item	Item property.
Metadata	Gets or set a dictionary with additional information that may be useful to understanding
Name	Get or set the name of the table.
RowCount

Property detail

property IDataTable.ColumnNames: tuple[str] | None

property IDataTable.Columns: List[Ansys.Mechanical.Interfaces.IDataSeries] | None

Explicitly get the columns of the data table.

property IDataTable.Count: int | None

Gets the number of columns in the table.

property IDataTable.IsFixedColumnCount: bool | None

Get whether additional columns can be added or removed from the contained T:Ansys.Mechanical.Interfaces.IDataSeries.

property IDataTable.IsFixedRowCount: bool | None

Get whether additional rows can be added or removed from the contained T:Ansys.Mechanical.Interfaces.IDataSeries.

property IDataTable.IsReadOnly: bool | None

Gets whether the data table is read-only.

property IDataTable.Item: Ansys.Mechanical.Interfaces.IDataSeries | None

Item property.

property IDataTable.Metadata: dict[str, Any] | None

Gets or set a dictionary with additional information that may be useful to understanding the context of data in the table.

property IDataTable.Name: str | None

Get or set the name of the table.

property IDataTable.RowCount: int | None

Method detail

IDataTable.Add(dataSeries: Ansys.Mechanical.Interfaces.IDataSeries) → None

Add a new column to the data table.

IDataTable.Clear() → None

Drops all columns from the data table.

IDataTable.Contains(name: str) → bool

Returns whether the data table contains a column with the specified name.

IDataTable.GetRow(rowIndex: int) → Iterable

IDataTable.Insert(columnIndex: int, dataSeries: Ansys.Mechanical.Interfaces.IDataSeries) → None

Insert a column at the specified index.

IDataTable.Remove(key: Any) → None

Removes the specified column. If the specifier of the column to remove is an T:System.Int32, it will
be interpreted as an index. If the specifier of the column to remove is a T:System.String, it will
be interpreted as a column name.

IDataTable.TryInsertRow(rowIndex: int, values: Iterable) → bool

Try to insert the values at the specified row index.

IDataTable.TryRemoveRow(rowIndex: int) → bool

Try to remove the specified row.