PDA

View Full Version : [OPEN] Ext.grid.column.Column sorter config is private



joshglendenning
6 Mar 2017, 1:03 PM
I'd like to have a grid column purely for display that does not use a dataIndex or have a value, but can still be sorted by a specified field. The "sorter" config on Ext.grid.column.Column solves this problem (just specify the field name as a string), but it is marked "private". Looking at the source it seems like it would be fine as a public API method; what's the reason for marking it private?

http://docs.sencha.com/extjs/6.2.0/c...tml#cfg-sorter (http://docs.sencha.com/extjs/6.2.0/classic/Ext.grid.column.Column.html#cfg-sorter)

evant
6 Mar 2017, 1:26 PM
It's not marked as private in the source, so it seems as though the doc parser is having some kind of issue:



/**
* @cfg {Function/String/Object/Ext.util.Sorter} sorter
* A Sorter, or sorter config object to apply when the standard user interface
* sort gesture is invoked. This is usually clicking this column header, but
* there are also menu options to sort ascending or descending.
*
* Note that a sorter may also be specified as a function which accepts two
* records to compare.
*
* In 6.2.0, a `{@link Ext.app.ViewController controller}` method can be used
* like so:
*
* sorter: {
* sorterFn: 'sorterMethodName'
* }
*
* @since 6.0.1
*/
sorter: null,


Will move this to the docs board, it's a public config.

Gary Schlosberg
7 Mar 2017, 7:59 AM
Thanks for the report. Seems to be a known issue, being tracked as DOXI-78.