Array functions

Most array functions are supported; some (such as value) were obsoleted by new parser and are not available. The only difference is that their names are preceeded by array_ instead of @Array.

Warning

Due to parser limitation, name of array has to be specified as string now; for example array_count("MyArray").

array_clear(array) - removes all elements from array
array_count(array) - returns number of elements in array
array_keys(array) - returns string containing EOL-separated keys of array - note that if you had imported a scalar (keys without values) into an array with Kommander you would not be able to access it with array_values("myarray") as you might think (since it seems to only have values) but would instead need to use array_keys() You might find a better choice for this is to use the new indexed arrays described below.
array_values(array) - returns string containing EOL-separated values of array
array_tostring(array) - returns string containing whole array as EOL-separated pairs containing key and value separated with TAB character
array_fromstring(array, string) - reads array from string (usually provided by array_tostring function)
array_remove(array, key) - removes item with key key from array

New in Kommander 1.3

array_indexedFromString(array, string, separator) - this compensates for Kommander not having indexed arrays. it creates an array with a zero based sequential index. Remember to use quotes on the array name and any strings not represented by a variable. The separatore argument is optional and defaults to "\t" [TAB] which is used to separate fields reading and writing tables, arrays or detail widgets. Remember this array index does not enforce any rules on its self. It is just like you created it with a for loop, just more convenient.
array_indexedInsertElements(array, key, string, separator) - this function is part of the indexed array suite and enables you to insert elements in your array while maintaining an index that is sequential, contiguous and unique. Set the index key to start at and the text string and how it is separated. The elements will be added shifting all the index numbers after by the number added.
array_indexedRemoveElements(array, key start, number) - this enables you to remove elements from an indexed array and avoid gaps in your index. Specify the key to start at and optionally how many to remove. The default is one. You will end up with a re-indexed array less the removed elements.
array_indexedToString(array, separator) - this enables you to convert your indexed array back into a string, particularly useful for detail widgets. For instance if you are displaying a database query result in TreeWidget1 and it has six columns you can use TreeWidget1.selection to get the selected row. it will be separated by tabs and you could look at a the fifth element by using str_section(TreeWidget1.selection, "\t", 4) (remember it is zero based). That's nice for reading a value, but if you want to change it you can see you have a lot more work to do. After you split that string you have to reassmble with val1+"\t"+val2... Using indexed arrays you could edit that fifth element like so...
```
idx = TreeWidget1.currentItem
array_indexedFromString("z", TreeWidget1.selection)
z[4] = "new value"
TreeWidget1.removeItem(idx)
TreeWidget1.insertItem(array_indexedToString("z"), idx)
```
Note that only two short lines were added to accomplish this! This was very welcome for database use.

Prev	Home	Next
Kommander functions	Up	File functions