rpti::item::tableofreference
Interact with items of type tableofreference.
- Supported Property Names
-name -value -parent
rpti::item::tableofreference create
Creates an item of type "tableofreference".
- Syntax
rpti::item::tableofreference create
- Parameters
-
- For
- Value: A full list of standard property names see Supported property name above.
- Returns
- The ID of the item type table or .tcl-error in case an error occurred during creation.
- Example
rpti::item::module create -name "My Module" -value {{A B C D} {2 2}} -parent $rootid value format : {{list data} {$numrows $numcols}}. data should match numrows X numcols
rpti::item::tableofreference delete
Deletes the item with the specified ID.
- Syntax
rpti::item::tableofreference delete
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
rpti::item::tableofreference delete -id $id
rpti::item::tableofreference get
Queries the value of one property.
- Syntax
rpti::item::tableofreference get
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- For
- Value: A full list of standard property names see Supported property name above.
- Returns
- The value of the specified property or .tcl-error in case of error.
- Example
rpti::item::tableofreference get -id $id -property parent
rpti::item::tableofreference getpropertyid
Queries ID of property.
- Syntax
rpti::item::tableofreference getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
ardi::item::text set -id $id -name "My Text Item" -value "Good monring, how are you today?"
rpti::item::tableofreference getpropertykeylist
Queries list of properties
- Syntax
rpti::item::tableofreference getpropertykeylist
- Parameters
-
- -id
- Item: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item::tableofreference set
Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.
- Syntax
rpti::item::tableofreference set
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- For
- Value: A full list of standard property names see Supported property name above.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
rpti::item::tableofreference set -id $id -name "My Table of References" -value {{X Y 0.1 0.2} {2 2}} -parent $parentid