Class type Ext_grid_column_Column.configs


class type configs = object .. end
Inherits
method align : Js.js_string Js.t Js.prop

Sets the alignment of the header and rendered columns. Possible values are: 'left', 'center', and 'right'.

Defaults to: 'left'

method baseCls : Js.js_string Js.t Js.prop

The base CSS class to apply to this component's element. This will also be prepended to elements within this component like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and you want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this component.

Defaults to: Ext.baseCSSPrefix + 'column-header'

method columns : 'a. 'a Js.t Js.js_array Js.t Js.prop

An optional array of sub-column definitions. This column becomes a group, and houses the columns defined in the columns config.

Group columns may not be sortable. But they may be hideable and moveable. And you may move headers into and out of a group. Note that if all sub columns are dragged out of a group, the group is destroyed.


method componentLayout : 'b. 'b Js.t Js.prop

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.

Generally, developers will not use this configuration as all provided Components which need their internal elements sizing (Such as input fields) come with their own componentLayout managers.

The default layout manager will be used on instances of the base Ext.Component class which simply sizes the Component's encapsulating element to the height and width specified in the setSize method.

Defaults to: 'columncomponent'

method dataIndex : Js.js_string Js.t Js.prop

The name of the field in the grid's Ext.data.Store's Ext.data.Model definition from which to draw the column's value. Required.


method detachOnRemove : bool Js.t Js.prop

So that when removing from group headers which are then empty and then get destroyed, there's no child DOM left

True to move any component to the detachedBody when the component is removed from this container. This option is only applicable when the component is not destroyed while being removed, see autoDestroy and remove. If this option is set to false, the DOM of the component will remain in the current place until it is explicitly moved.

Defaults to: true

method draggable : bool Js.t Js.prop

False to disable drag-drop reordering of this column.

Defaults to: true

method editRenderer : 'c. 'c Js.callback Js.prop

A renderer to be used in conjunction with RowEditing. This renderer is used to display a custom value for non-editable fields.

Defaults to: false

method editor : 'd. 'd Js.t Js.prop

An optional xtype or config object for a Field to use for editing. Only applicable if the grid is using an Editing plugin.


method emptyCellText : Js.js_string Js.t Js.prop

The text to diplay in empty cells (cells with a value of undefined, null, or '').

Defaults to   aka  .

Defaults to: undefined

method groupable : bool Js.t Js.prop

If the grid uses a Ext.grid.feature.Grouping, this option may be used to disable the header menu item to group by the column selected. By default, the header menu group option is enabled. Set to false to disable (but still show) the group option in the header menu for the column.


method hideable : bool Js.t Js.prop

False to prevent the user from hiding this column.

Defaults to: true

method lockable : bool Js.t Js.prop

If the grid is configured with enableLocking, or has columns which are configured with a locked value, this option may be used to disable user-driven locking or unlocking of this column. This column will remain in the side into which its own locked configuration placed it.


method locked : bool Js.t Js.prop

True to lock this column in place. Implicitly enables locking on the grid. See also Ext.grid.Panel.enableLocking.

Defaults to: false

method menuDisabled : bool Js.t Js.prop

True to disable the column header menu containing sort/hide options.

Defaults to: false

method menuText : Js.js_string Js.t Js.prop

The text to render in the column visibility selection menu for this column. If not specified, will default to the text value.


method renderTpl : 'e. 'e Js.t Js.prop

An XTemplate used to create the internal structure inside this Component's encapsulating Element.

You do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container, this defaults to null which means that they will be initially rendered with no internal structure; they render their Element empty. The more specialized Ext JS and Sencha Touch classes which use a more complex DOM structure, provide their own template definitions.

This is intended to allow the developer to create application-specific utility Components with customized internal structure.

Upon rendering, any created child elements may be automatically imported into object properties using the renderSelectors and childEls options.

Defaults to: '<div id="{id}-titleEl" {tipMarkup}class="' + Ext.baseCSSPrefix + 'column-header-inner">' + '<span id="{id}-textEl" class="' + Ext.baseCSSPrefix + 'column-header-text' + '{childElCls}">' + '{text}' + '</span>' + '<tpl if="!menuDisabled">' + '<div id="{id}-triggerEl" class="' + Ext.baseCSSPrefix + 'column-header-trigger' + '{childElCls}"></div>' + '</tpl>' + '</div>' + '{%this.renderContainer(out,values)%}'

method renderer : 'f. 'f Js.t Js.prop

A renderer is an 'interceptor' method which can be used to transform data (value, appearance, etc.) before it is rendered. Example:

{
    renderer: function(value){
        if (value === 1) {
            return '1 person';
        }
        return value + ' people';
    }
}

Additionally a string naming an Ext.util.Format method can be passed:

{
    renderer: 'uppercase'
}

Defaults to: false

method resizable_bool : bool Js.t Js.prop

False to prevent the column from being resizable.

Defaults to: true

method scope : 'g. 'g Js.t Js.prop

The scope to use when calling the renderer function.


method sortable : bool Js.t Js.prop

False to disable sorting of this column. Whether local/remote sorting is used is specified in Ext.data.Store.remoteSort.

Defaults to: true

method stateId : Js.js_string Js.t Js.prop

An identifier which identifies this column uniquely within the owning grid's state.

This does not have to be globally unique. A column's state is not saved standalone. It is encapsulated within the owning grid's state.


method tdCls : Js.js_string Js.t Js.prop

A CSS class names to apply to the table cells for this column.

Defaults to: ''

method text : Js.js_string Js.t Js.prop

The header text to be used as innerHTML (html tags are accepted) to display in the Grid. Note: to have a clickable header with no text displayed you can use the default of &#160; aka &nbsp;.

Defaults to: '&#160;'

method tooltip : Js.js_string Js.t Js.prop

A tooltip to display for this column header


method tooltipType : Js.js_string Js.t Js.prop

The type of tooltip to use. Either 'qtip' for QuickTips or 'title' for title attribute.

Defaults to: "qtip"

method afterComponentLayout : 'h 'i.
((< activeItem : 'l. 'l Js.t Js.prop; afterComponentLayout : 'h 'i. 'j;
afterHide : 'm 'n.
('k Js.t,
'm Js.callback Js.optdef -> 'n Js.t Js.optdef -> unit)
Js.meth_callback Js.writeonly_prop;
afterLayout : 'o.
('k Js.t,
(#Ext_layout_container_Container.t as 'o) Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
afterRender : ('k Js.t, unit -> unit) Js.meth_callback
Js.writeonly_prop;
afterSetPosition : ('k Js.t, Js.number Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
afterShow : 'p 'q 'r.
('k Js.t,
'p Js.t Js.optdef ->
'q Js.callback Js.optdef -> 'r Js.t Js.optdef -> unit)
Js.meth_callback Js.writeonly_prop;
align : Js.js_string Js.t Js.prop; anchorSize : 's. 's Js.t Js.prop;
autoDestroy : bool Js.t Js.prop; autoEl : 't. 't Js.t Js.prop;
autoRender : 'u. 'u Js.t Js.prop; autoScroll : bool Js.t Js.prop;
autoShow : bool Js.t Js.prop; baseCls : Js.js_string Js.t Js.prop;
beforeComponentLayout : ('k Js.t,
Js.number Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
beforeDestroy : ('k Js.t, unit -> unit) Js.meth_callback
Js.writeonly_prop;
beforeLayout : ('k Js.t, unit -> unit) Js.meth_callback
Js.writeonly_prop;
beforeShow : ('k Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
border : 'v. 'v Js.t Js.prop;
bubbleEvents : Js.js_string Js.t Js.js_array Js.t Js.prop;
childEls : 'w. 'w Js.t Js.js_array Js.t Js.prop;
cls : Js.js_string Js.t Js.prop; columnWidth : 'x. 'x Js.t Js.prop;
columns : 'a. 'a Js.t Js.js_array Js.t Js.prop;
componentCls : Js.js_string Js.t Js.prop;
componentLayout : 'b. 'b Js.t Js.prop; constrain : bool Js.t Js.prop;
constrainTo : 'y. 'y Js.t Js.prop;
constraintInsets : 'z. 'z Js.t Js.prop;
contentEl : Js.js_string Js.t Js.prop; data : 'a1. 'a1 Js.t Js.prop;
dataIndex : Js.js_string Js.t Js.prop;
defaultAlign : Js.js_string Js.t Js.prop;
defaultRenderer : ('k Js.t, unit -> unit) Js.meth_callback
Js.writeonly_prop;
defaultType : Js.js_string Js.t Js.prop;
defaultWidth : Js.number Js.t Js.prop;
defaults : 'b1. 'b1 Js.t Js.prop; detachOnRemove : bool Js.t Js.prop;
disabled : bool Js.t Js.prop; disabledCls : Js.js_string Js.t Js.prop;
draggable : bool Js.t Js.prop; draggable_obj : 'c1. 'c1 Js.t Js.prop;
editRenderer : 'c. 'c Js.callback Js.prop;
editor : 'd. 'd Js.t Js.prop;
emptyCellText : Js.js_string Js.t Js.prop;
enableColumnHide : bool Js.t Js.prop; fixed : bool Js.t Js.prop;
floating : bool Js.t Js.prop; focusOnToFront : bool Js.t Js.prop;
formBind : bool Js.t Js.prop; frame : bool Js.t Js.prop;
groupable : bool Js.t Js.prop; height : Js.number Js.t Js.prop;
hidden : bool Js.t Js.prop; hideMode : Js.js_string Js.t Js.prop;
hideable : bool Js.t Js.prop; html : 'd1. 'd1 Js.t Js.prop;
id : Js.js_string Js.t Js.prop;
initComponent : ('k Js.t, unit -> unit) Js.meth_callback
Js.writeonly_prop;
itemId : Js.js_string Js.t Js.prop; items : 'e1. 'e1 Js.t Js.prop;
layout : 'f1. 'f1 Js.t Js.prop; listeners : 'g1. 'g1 Js.t Js.prop;
loader : 'h1. 'h1 Js.t Js.prop; lockable : bool Js.t Js.prop;
locked : bool Js.t Js.prop; margin : 'i1. 'i1 Js.t Js.prop;
maxHeight : Js.number Js.t Js.prop; maxWidth : Js.number Js.t Js.prop;
menuDisabled : bool Js.t Js.prop; menuText : Js.js_string Js.t Js.prop;
minHeight : Js.number Js.t Js.prop; minWidth : Js.number Js.t Js.prop;
onAdd : 'j1.
('k Js.t,
(#Ext_Component.t as 'j1) Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onAdded : 'k1.
('k Js.t, 'k1 Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onBeforeAdd : 'l1.
('k Js.t, (#Ext_Component.t as 'l1) Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onDestroy : ('k Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
onDisable : ('k Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
onEnable : ('k Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
onHide : 'm1 'n1 'o1.
('k Js.t,
'm1 Js.t Js.optdef ->
'n1 Js.callback Js.optdef -> 'o1 Js.t Js.optdef -> unit)
Js.meth_callback Js.writeonly_prop;
onPosition : ('k Js.t, Js.number Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onRemove : 'p1.
('k Js.t,
(#Ext_Component.t as 'p1) Js.t -> bool Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onRemoved : ('k Js.t, bool Js.t -> unit) Js.meth_callback
Js.writeonly_prop;
onRender : ('k Js.t, Ext_dom_Element.t Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onResize : 'q1 'r1 's1 't1.
('k Js.t,
'q1 Js.t -> 'r1 Js.t -> 's1 Js.t -> 't1 Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onShow : 'u1 'v1 'w1.
('k Js.t,
'u1 Js.t Js.optdef ->
'v1 Js.callback Js.optdef -> 'w1 Js.t Js.optdef -> unit)
Js.meth_callback Js.writeonly_prop;
onShowComplete : 'x1 'y1.
('k Js.t,
'x1 Js.callback Js.optdef ->
'y1 Js.t Js.optdef -> unit)
Js.meth_callback Js.writeonly_prop;
overCls : Js.js_string Js.t Js.prop;
overflowX : Js.js_string Js.t Js.prop;
overflowY : Js.js_string Js.t Js.prop; padding : 'z1. 'z1 Js.t Js.prop;
plugins : 'a2. 'a2 Js.t Js.prop; region : 'b2. 'b2 Js.t Js.prop;
renderData : 'c2. 'c2 Js.t Js.prop;
renderSelectors : 'd2. 'd2 Js.t Js.prop;
renderTo : 'e2. 'e2 Js.t Js.prop; renderTpl : 'e. 'e Js.t Js.prop;
renderer : 'f. 'f Js.t Js.prop; resizable : 'f2. 'f2 Js.t Js.prop;
resizable_bool : bool Js.t Js.prop;
resizeHandles : Js.js_string Js.t Js.prop; rtl : bool Js.t Js.prop;
saveDelay : Js.number Js.t Js.prop; scope : 'g. 'g Js.t Js.prop;
sealed : bool Js.t Js.prop; shadow : 'g2. 'g2 Js.t Js.prop;
shadowOffset : Js.number Js.t Js.prop;
shrinkWrap : 'h2. 'h2 Js.t Js.prop; sortable : bool Js.t Js.prop;
stateEvents : Js.js_string Js.t Js.js_array Js.t Js.prop;
stateId : Js.js_string Js.t Js.prop; stateful : bool Js.t Js.prop;
style : 'i2. 'i2 Js.t Js.prop; suspendLayout : bool Js.t Js.prop;
tdCls : Js.js_string Js.t Js.prop; text : Js.js_string Js.t Js.prop;
toFrontOnShow : bool Js.t Js.prop; tooltip : Js.js_string Js.t Js.prop;
tooltipType : Js.js_string Js.t Js.prop; tpl : 'j2. 'j2 Js.t Js.prop;
tplWriteMode : Js.js_string Js.t Js.prop;
ui : Js.js_string Js.t Js.prop; weight : Js.number Js.t Js.prop;
width : Js.number Js.t Js.prop; xtype : Js.js_string Js.t Js.prop; .. >
as 'k)
Js.t, Js.number Js.t -> Js.number Js.t -> 'h Js.t -> 'i Js.t -> unit)
Js.meth_callback Js.writeonly_prop as 'j
See method t.afterComponentLayout
method afterRender : ('k Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop
See method t.afterRender
method defaultRenderer : ('k Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop
See method t.defaultRenderer
method initComponent : ('k Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop
See method t.initComponent
method onAdd : 'j1.
('k Js.t, (#Ext_Component.t as 'j1) Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop
See method t.onAdd
method onDestroy : ('k Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop
See method t.onDestroy
method onRemove : 'p1.
('k Js.t, (#Ext_Component.t as 'p1) Js.t -> bool Js.t -> unit)
Js.meth_callback Js.writeonly_prop
See method t.onRemove