Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
wiki:colmodel_options [2011/06/19 06:47] tony |
wiki:colmodel_options [2014/02/20 09:20] tony |
||
|---|---|---|---|
| Line 31: | Line 31: | ||
| |formatoptions|array|Format options can be defined for particular columns, overwriting the defaults from the language file. See [[wiki:predefined_formatter |Formatter]] for more details.|none| | |formatoptions|array|Format options can be defined for particular columns, overwriting the defaults from the language file. See [[wiki:predefined_formatter |Formatter]] for more details.|none| | ||
| |formatter|mixed|The predefined types (string) or custom function name that controls the format of this field. See [[wiki:predefined_formatter |Formatter]] for more details.|none| | |formatter|mixed|The predefined types (string) or custom function name that controls the format of this field. See [[wiki:predefined_formatter |Formatter]] for more details.|none| | ||
| + | |frozen|boolean|If set to true determines that this column will be frozen after calling the setFrozenColumns method|false| | ||
| |hidedlg|boolean|If set to true this column will not appear in the modal dialog where users can choose which columns to show or hide. See [[Show/Hide Columns]].|false| | |hidedlg|boolean|If set to true this column will not appear in the modal dialog where users can choose which columns to show or hide. See [[Show/Hide Columns]].|false| | ||
| |hidden|boolean|Defines if this column is hidden at initialization.|false| | |hidden|boolean|Defines if this column is hidden at initialization.|false| | ||
| Line 42: | Line 43: | ||
| |searchoptions|array|Defines the search options used searching [[:wiki:search_config | Search Configuration]]|empty| | |searchoptions|array|Defines the search options used searching [[:wiki:search_config | Search Configuration]]|empty| | ||
| |sortable|boolean|Defines is this can be sorted.|true| | |sortable|boolean|Defines is this can be sorted.|true| | ||
| + | |sortfunc|function|Custom function to make custom sorting when datatype is local. Three parameters a, b and direction are passed. The //a// and //b// parameters are values to be compared direction is numeric 1 and -1 for ascending and descending order. The function should return 1, -1 or 0|null| | ||
| |sorttype|mixed|Used when datatype is local. Defines the type of the column for appropriate sorting.Possible values: \\ int/integer - for sorting integer \\ float/number/currency - for sorting decimal numbers \\ date - for sorting date \\ text - for text sorting \\ function - defines a custom function for sorting. To this function we pass the value to be sorted and it should return a value too. \\ See [[wiki:retrieving_data#array_data | Array Data]] |text| | |sorttype|mixed|Used when datatype is local. Defines the type of the column for appropriate sorting.Possible values: \\ int/integer - for sorting integer \\ float/number/currency - for sorting decimal numbers \\ date - for sorting date \\ text - for text sorting \\ function - defines a custom function for sorting. To this function we pass the value to be sorted and it should return a value too. \\ See [[wiki:retrieving_data#array_data | Array Data]] |text| | ||
| |stype|string| Determines the type of the element when searching. See [[:wiki:search_config | Search Configuration]]|text| | |stype|string| Determines the type of the element when searching. See [[:wiki:search_config | Search Configuration]]|text| | ||
| |surl|string|Valid only in [[Custom Searching]] and edittype : 'select' and describes the url from where we can get already-constructed select element|empty string| | |surl|string|Valid only in [[Custom Searching]] and edittype : 'select' and describes the url from where we can get already-constructed select element|empty string| | ||
| + | |template| object| Set of valid properties for the colModel. This option can be used if you want to overwrite a lot of default values in the column model with easy. See cmTemplate in grid options | null | | ||
| |title|boolean|If this option is false the title is not displayed in that column when we hover a cell with the mouse|true| | |title|boolean|If this option is false the title is not displayed in that column when we hover a cell with the mouse|true| | ||
| |width|number|Set the initial width of the column, in pixels. This value currently can not be set as percentage|150| | |width|number|Set the initial width of the column, in pixels. This value currently can not be set as percentage|150| | ||
| - | |xmlmap|string|Defines the xml mapping for the column in the incomming xml file. Use a CCS specification for this See [[Retrieving Data]]|none| | + | |xmlmap|string|Defines the xml mapping for the column in the incomming xml file. Use a CSS specification for this See [[Retrieving Data]]|none| |
| |unformat|function| Custom function to "unformat" a value of the cell when used in editing See [[Custom Formatter]]. (Unformat is also called during sort operations. The value returned by unformat is the value compared during the sort.) |null| | |unformat|function| Custom function to "unformat" a value of the cell when used in editing See [[Custom Formatter]]. (Unformat is also called during sort operations. The value returned by unformat is the value compared during the sort.) |null| | ||
| - | |viewable|boolean|This option is valid only when [[form_editing#viewgridrow|viewGridRow]] method is activated. When the option is set to false the column is does not appear in view Form|true| | + | |viewable|boolean|This option is valid only when [[form_editing#viewgridrow|viewGridRow]] method is activated. When the option is set to false the column does not appear in view Form|true| |
| As mentioned above the options in colModel can be get or sfunction are: rowId - the id of the row \\ | As mentioned above the options in colModel can be get or sfunction are: rowId - the id of the row \\ | ||
