TableObject is an abstraction of a 2D table with X columns and Y rows where each cell can be used to store any kind of data.
Columns can be labeled with a textual name which can be used to access them anytime (data can be also accessed via numeric row and column indexes).
The number of rows for the created table (Rows can be added or modified anytime later).
The number of columns to create or an array of strings containing the column labels for all of the columns that will be created (Columns can be added or modified anytime later).
The constructed TableObject
Stores all the table cells data. The values are stored as key / value where key is the row and column index (r-c) and value the stored item
Stores a list with all the column names on the table. The values are stored as key / value where key is the column index and value the column label
Stores the number of columns on the current table instance
Stores the number of rows on the current table instance
Auxiliary method to validate that a given column index or label belongs to the current table
An integer or a string containing the index or label for the column that we want to validate
A valid column index based on the specified integer or label.
Auxiliary method to validate that a given row index belongs to the current table
An integer containing the index for the row that we want to validate
A valid row index based on the specified integer
Add the specified amount of columns to the table.
The number of columns that will be added to the table
Optionally we can list all the labels to define for the new columns that will be added
Defines the column index where the new columns will be inserted. Old columns that are located at the insertion point will not be deleted, they will be moved to the Right. By default all the new columns will be appended at the end of the table unless a positive value is specified here.
True if the operation was successful
Add the specified amount of rows to the table.
The number of rows that will be added to the table
Defines the row index where the new rows will be inserted. Old rows that are located at the insertion point will not be deleted, they will be moved down. By default all the new rows will be appended at the bottom of the table unless a positive value is specified here.
True if the operation was successful
Get the total number of cells that are currently available on this table
The total number of cells on the table
Get the total number of columns that are currently available on this table
The total number of columns on the table
Get the total number of rows that are currently available on this table
The total number of rows on the table
Get the value contained at the specified table cell
An integer containing the index for the row that we want to retrieve
An integer or a string containing the index or label for the column that we want to retrieve
The value for the cell that is located at the specified row and column
Get all the elements that are located at the specified column index or label.
An integer or a string containing the index or label for the column that we want to retrieve
All the table elements that belong to the required column
Get the numeric column index from it's label
The label for an existing column
The numeric index that is related to the given column label
Get the defined column name for a given column index
a numeric column index
The column label for the specified numeric index
Get a list with all the currently defined column names in the same order as they are assigned to the table. If the table contains columns but no names are defined, a list with empty strings will be returned
A list of strings with the column names
Get all the elements that are located at the specified row index
An integer containing the index for the row that we want to retrieve
All the table elements that belong to the required row
Delete a whole column and all its related data from the table
An integer or a string containing the index or label for the column that we want to delete
void
Delete a whole row and all its related data from the table
An integer containing the index for the row that we want to delete
void
Set the value for a table cell
An integer containing the index for the row that we want to set
An integer or a string containing the index or label for the column that we want to set
The value we want to set to the specified cell. Any type is allowed, and different cells can contain values of different types.
The assigned value after beign stored into the table cell
Fill the data on all the rows for the given column index or label
An integer or a string containing the index or label for the column that we want to fill
An array with all the values that will be assigned to the table rows on the specified column. Array length must match rows number
void
Set the label to an existing table column.
An integer or a string containing the index or label for the column to which we want to assign a label
The new label that will be assigned to the specified column
True if the column name was correctly assigned
Define the names for the current table columns (Already defined column names will be overriden).
List of names that will be applied to the table columns. It must have the same number of items and in the same order as the table columns.
The list of column names after beign assigned
Fill all the data for the specified row
An integer containing the index for the row that we want to set
An array with all the values that will be assigned to the table row. Array length must match columns number
void
Generated using TypeDoc
A 2D table structure