ardi::item

ardi::item apply args

For better performance data created, manipulated or deleted go into a cache. This API processes the cached data, clears the cache and redraws the GUI if needed.
Returns
1 for ok
tcl-error in case of error

ardi::item delete args

Deletes the item with the specified ID.
Parameters
-id
value: item ID.
default value: ""
Returns
1 for ok
tcl-error in case of error

ardi::item get args

Get property value.
Parameters
-id
value: item ID,
-property Value: valid property name. To get a complete property list, use ::ardi::item getpropertykeylist
For example, to get the name of the image item, use ::ardi::item get -id $image -property name.
-key
value: property Key. default value: ""
Returns
1 if valid, 0 if invalid

ardi::item getpropertyid args

Queries id of property.
Parameters
-id
value: item ID
-key
value: property key

ardi::item getpropertykeylist args

Queries list of properties.
Parameters
-id
value: item ID
Returns
list of property keys for a particular item id.

ardi::item getroot

Queries the ID of the report root item. This is the top most item.
Returns
the ID of the report root item.

ardi::item getselection

Queries the currently selected item.
Returns
select item ID.

ardi::item gettype args

Queries the type of the item with the specified ID.
Parameters
-id
value: item ID.
default value: ""
Returns
the type of the item.

ardi::item gettypelist

Queries available types of items.
Returns
a list of item types.

ardi::item hasproperty

Checks if the item has property with specified key.
Parameters
-id
value: item ID, default value: ""
-key
value: property Key. default value: ""
Returns
1 if valid, 0 if invalid

ardi::item isvalid

Checks if the item with the specified ID is valid.
Parameters
-id
value: item ID, default value: ""
Returns
1 if valid, 0 if invalid

ardi::item set

Sets property value.
Parameters
-id
value: item ID,
-property
value: property Key. To get list of all property list, use ::ardi::item getpropertykeylist
value: value to be assigned to property
For example, to change name of the image item to "Model Overview"; we can use ::ardi::item set -id $image -name "Model Overview".
Returns
1 if valid, 0 if invalid