ardi::item::table
Interact with items of type table.
Supported property names are: -name -value -parent -type (read only) -numberofrows -numberofcolumns -showcolumnheader -showrowheader. All properties available can be passed via the "create" API or modified on an existing item via the "set" API.
ardi::item::table::create args
Creates an item of type "table".
- Parameters
- For a full list of property names, see above.
- Returns
- The ID of the item or tcl-error in case an error occurred during creation. i.e ardi::api::item::table create -name "My Table Item"
ardi::item::table::delete args
Deletes the item with the specified ID.
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- Returns
- 1 for ok
ardi::item::table::get args
Queries the value of one property.
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- For a full list of property names, see above.
- Returns
- The value of the specified property or tcl-error in case of error usage: ardi::item::table get -id $id -property parent
ardi::item::table::getcell args
Queries the value on a cell identified by row and column ID. Row and column IDs start
with 0.
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- -row (mandatory)
- value: row ID. The ID of the row.
- -column (mandatory)
- value: column ID. The ID of the column.
- Returns
- the value of the cell, tcl-error in case of error i.e ardi::api::item::table getcell -id $id -row 0 -column 0
ardi::item::table::getheader args
Queries the header text on a row or on a column. Row and column IDs start with 1.
Specify either row or column ID to query the current value.
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- -row
- value: row ID. The ID of the row you want to query the header text.
- -column
- value: column ID. The ID of the column you want to query the header text.
- Returns
- the header text
ardi::item::table::getpropertyid args
Queries id of property.
- Parameters
-
- -id
- value: item ID
- -key
- value: property key
ardi::item::table::getpropertykeylist args
Queries list of properties.
- Parameters
-
- -id
- value: item ID
- Returns
- list of property keys for a particular item ID
ardi::item::table::set args
Sets one or multiple parameters to specified values. The type of the item is assigned
upon creation and cannot be changed after.
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- For a full list of property names, see above.
- Returns
- 1 for ok
ardi::item::table::setcell args
Sets the value on a cell identified by row and column ID. Row and column IDs start
with 0.
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- -row (mandatory)
- value: row ID. The ID of the row.
- -column (mandatory)
- value: column ID. The ID of the column.
- -value
- value: The value you want to set on the cell.
- Returns
- 1 for ok
ardi::item::table::setheader args
Sets the header text on a row or on a column. Row and column IDs start with 0.
Specify either row or column ID to set the header text to desired value.
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- -row
- value: row ID. The ID of the row you want to set a particular header text.
- -column
- value: column ID. The ID of the column you want to set a particular header text.
- -value
- value: The text you want to set as header of the spcified row or column ID.
- Returns
- 1 for ok