ardi::item::tableofreference
Interact with items of type tableofreference.
Supported property names are: -name -value -parent.. All properties available can be passed via the "create" API or modified on an existing item via the "set" API.
ardi::item::tableofreference create args
Creates an item of type "tableofreference".
- 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::tableofreference create -name "My Module" -value {{A B C D}{2 2}} -parent $rootid value format : {{list data}{$numrows $numcols}}
ardi::item::tableofreference 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::tableofreference 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::tableofreference get -id $id -property parent
ardi::item::tableofreference getpropertyid args
Queries id of property.
- Parameters
-
- -id
- value: item ID
- -key
- value: property key
ardi::item::tableofreference getpropertykeylist args
Queries list of properties.
- Parameters
-
- -id
- value: item ID
- Returns
- list of property keys for a particular item ID
ardi::item::tableofreference 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