class type configs =Inheritsobject
..end
method allowDeselect : bool Js.t Js.prop
True to allow deselecting a record. This config is forwarded to Ext.selection.Model.allowDeselect.
Defaults to: false
method columnLines : bool Js.t Js.prop
Adds column line styling
method columns : 'a. 'a Js.t Js.prop
An array of column definition objects which define all columns that appear in this grid. Each column definition provides the header text for the column, and a definition of where the data for that column comes from.
This can also be a configuration object for a {Ext.grid.header.Container HeaderContainer} which may override certain default configurations if necessary. For example, the special layout may be overridden to use a simpler layout, or one can set default values shared by all columns:
columns: {
items: [
{
text: "Column A"
dataIndex: "field_A"
},{
text: "Column B",
dataIndex: "field_B"
},
...
],
defaults: {
flex: 1
}
}
method deferRowRender : bool Js.t Js.prop
Defaults to true to enable deferred row rendering.
This allows the View to execute a refresh quickly, with the expensive update of the row structure deferred so that layouts with GridPanels appear, and lay out more quickly.
method disableSelection : bool Js.t Js.prop
True to disable selection model.
Defaults to: false
method emptyText : Js.js_string Js.t Js.prop
Default text (html tags are accepted) to display in the Panel body when the Store is empty. When specified, and the Store is empty, the text will be rendered inside a DIV with the CSS class "x-grid-empty".
method enableColumnHide : bool Js.t Js.prop
False to disable column hiding within this grid.
Defaults to: true
method enableColumnMove : bool Js.t Js.prop
False to disable column dragging within this grid.
Defaults to: true
method enableColumnResize : bool Js.t Js.prop
False to disable column resizing within this grid.
Defaults to: true
method enableLocking : bool Js.t Js.prop
Configure as true
to enable locking support for this grid. Alternatively, locking will also be automatically
enabled if any of the columns in the columns configuration contain a locked config option.
A locking grid is processed in a special way. The configuration options are cloned and two grids are created to be the locked (left) side and the normal (right) side. This Panel becomes merely a container which arranges both in an HBox layout.
Plugins may be targeted at either locked, or unlocked grid, or, both, in which case the plugin is cloned and used on both sides.
Plugins may also be targeted at the containing locking Panel.
This is configured by specifying a lockableScope
property in your plugin which may have the following values:
"both"
(the default) - The plugin is added to both grids"top"
- The plugin is added to the containing Panel"locked"
- The plugin is added to the locked (left) grid"normal"
- The plugin is added to the normal (right) gridIf both
is specified, then each copy of the plugin gains a property lockingPartner
which references its sibling on the other side so that they
can synchronize operations is necessary.
Features may also be configured with lockableScope
and may target the locked grid, the normal grid or both grids. Features
also get a lockingPartner
reference injected.
Defaults to: false
method features : 'b. 'b Js.t Js.prop
An array of grid Features to be added to this grid. Can also be just a single feature instead of array.
Features config behaves much like plugins. A feature can be added by either directly referencing the instance:
features: [Ext.create('Ext.grid.feature.GroupingSummary', {groupHeaderTpl: 'Subject: {name}'})],
By using config object with ftype:
features: [{ftype: 'groupingsummary', groupHeaderTpl: 'Subject: {name}'}],
Or with just a ftype:
features: ['grouping', 'groupingsummary'],
See Ext.enums.Feature for list of all ftypes.
method forceFit : bool Js.t Js.prop
True to force the columns to fit into the available width. Headers are first sized according to configuration, whether that be a specific width, or flex. Then they are all proportionally changed in width so that the entire content width is used. For more accurate control, it is more optimal to specify a flex setting on the columns that are to be stretched & explicit widths on columns that are not.
method hideHeaders : bool Js.t Js.prop
True to hide column headers.
Defaults to: false
method layout : 'c. 'c Js.t Js.prop
Important: In order for child items to be correctly sized and
positioned, typically a layout manager must be specified through
the layout
configuration option.
The sizing and positioning of child items is the responsibility of the Container's layout manager which creates and manages the type of layout you have in mind. For example:
If the layout configuration is not explicitly specified for a general purpose container (e.g. Container or Panel) the default layout manager will be used which does nothing but render child components sequentially into the Container (no sizing or positioning will be performed in this situation).
layout may be specified as either as an Object or as a String:
Example usage:
layout: {
type: 'vbox',
align: 'left'
}
type
The layout type to be used for this container. If not specified, a default Ext.layout.container.Auto will be created and used.
Valid layout type
values are listed in Ext.enums.Layout.
Layout specific configuration properties
Additional layout specific configuration properties may also be
specified. For complete details regarding the valid config options for
each layout type, see the layout class corresponding to the type
specified.
Example usage:
layout: 'vbox'
layout
The layout type
to be used for this container (see Ext.enums.Layout
for list of valid values).
Additional layout specific configuration properties. For complete
details regarding the valid config options for each layout type, see the
layout class corresponding to the layout
specified.
If a certain Container class has a default layout (For example a Toolbar
with a default Box
layout), then to simply configure the default layout,
use an object, but without the type
property:
xtype: 'toolbar',
layout: {
pack: 'center'
}
Defaults to: 'fit'
method rowLines : bool Js.t Js.prop
Adds row line styling
Defaults to: true
method scroll : 'd. 'd Js.t Js.prop
Scrollers configuration. Valid values are 'both', 'horizontal' or 'vertical'. True implies 'both'. False implies 'none'.
Defaults to: true
method sealedColumns : bool Js.t Js.prop
True to constrain column dragging so that a column cannot be dragged in or out of it's current group. Only relevant while enableColumnMove is enabled.
Defaults to: false
method selModel : 'e. 'e Js.t Js.prop
A selection model instance or config object. In latter case the selType config option determines to which type of selection model this config is applied.
method selType : Js.js_string Js.t Js.prop
An xtype of selection model to use. Defaults to 'rowmodel'. This is used to create selection model if just a config object or nothing at all given in selModel config.
Defaults to: 'rowmodel'
method sortableColumns : bool Js.t Js.prop
False to disable column sorting via clicking the header and via the Sorting menu items.
Defaults to: true
method store : Ext_data_Store.t Js.t Js.prop
The Store the grid should use as its data source.
method verticalScroller : 'f. 'f Js.t Js.prop
A config object to be used when configuring the scroll monitor to control refreshing of data in an "infinite grid".
Configurations of this object allow fine tuning of data caching which can improve performance and usability of the infinite grid.
method view : Ext_view_Table.t Js.t Js.prop
The Ext.view.Table used by the grid. Use viewConfig to just supply some config options to view (instead of creating an entire View instance).
method viewConfig : 'g. 'g Js.t Js.prop
A config object that will be applied to the grid's UI view. Any of the config options available for Ext.view.Table can be specified here. This option is ignored if view is specified.
method viewType : Js.js_string Js.t Js.prop
method afterCollapse : ((< activeItem : 'j. 'j Js.t Js.prop; afterCollapse : 'h;
afterComponentLayout : 'k 'l.
('i Js.t,
Js.number Js.t ->
Js.number Js.t -> 'k Js.t -> 'l Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
afterExpand : ('i Js.t, bool Js.t -> unit) Js.meth_callback
Js.writeonly_prop;
afterHide : 'm 'n.
('i Js.t,
'm Js.callback Js.optdef -> 'n Js.t Js.optdef -> unit)
Js.meth_callback Js.writeonly_prop;
afterLayout : 'o.
('i Js.t,
(#Ext_layout_container_Container.t as 'o) Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
afterRender : ('i Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
afterSetPosition : ('i Js.t, Js.number Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
afterShow : 'p 'q 'r.
('i Js.t,
'p Js.t Js.optdef ->
'q Js.callback Js.optdef -> 'r Js.t Js.optdef -> unit)
Js.meth_callback Js.writeonly_prop;
allowDeselect : bool Js.t Js.prop; anchorSize : 's. 's Js.t Js.prop;
animCollapse : bool 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; bbar : 'v. 'v Js.t Js.prop;
beforeComponentLayout : ('i Js.t,
Js.number Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
beforeDestroy : ('i Js.t, unit -> unit) Js.meth_callback
Js.writeonly_prop;
beforeLayout : ('i Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
beforeShow : ('i Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
bodyBorder : bool Js.t Js.prop; bodyCls : 'w. 'w Js.t Js.prop;
bodyPadding : 'x. 'x Js.t Js.prop; bodyStyle : 'y. 'y Js.t Js.prop;
border : 'z. 'z Js.t Js.prop;
bubbleEvents : Js.js_string Js.t Js.js_array Js.t Js.prop;
buttonAlign : Js.js_string Js.t Js.prop; buttons : 'a1. 'a1 Js.t Js.prop;
childEls : 'b1. 'b1 Js.t Js.js_array Js.t Js.prop;
closable : bool Js.t Js.prop; closeAction : Js.js_string Js.t Js.prop;
cls : Js.js_string Js.t Js.prop;
collapseDirection : Js.js_string Js.t Js.prop;
collapseFirst : bool Js.t Js.prop;
collapseMode : Js.js_string Js.t Js.prop; collapsed : bool Js.t Js.prop;
collapsedCls : Js.js_string Js.t Js.prop;
collapsible : bool Js.t Js.prop; columnLines : bool Js.t Js.prop;
columnWidth : 'c1. 'c1 Js.t Js.prop; columns : 'a. 'a Js.t Js.prop;
componentCls : Js.js_string Js.t Js.prop;
componentLayout : 'd1. 'd1 Js.t Js.prop; constrain : bool Js.t Js.prop;
constrainHeader : bool Js.t Js.prop; constrainTo : 'e1. 'e1 Js.t Js.prop;
constraintInsets : 'f1. 'f1 Js.t Js.prop;
contentEl : Js.js_string Js.t Js.prop; data : 'g1. 'g1 Js.t Js.prop;
defaultAlign : Js.js_string Js.t Js.prop;
defaultDockWeights : 'h1. 'h1 Js.t Js.prop;
defaultType : Js.js_string Js.t Js.prop;
defaults : 'i1. 'i1 Js.t Js.prop; deferRowRender : bool Js.t Js.prop;
detachOnRemove : bool Js.t Js.prop; disableSelection : bool Js.t Js.prop;
disabled : bool Js.t Js.prop; disabledCls : Js.js_string Js.t Js.prop;
dockedItems : 'j1. 'j1 Js.t Js.prop; draggable : bool Js.t Js.prop;
draggable_obj : 'k1. 'k1 Js.t Js.prop;
emptyText : Js.js_string Js.t Js.prop;
enableColumnHide : bool Js.t Js.prop;
enableColumnMove : bool Js.t Js.prop;
enableColumnResize : bool Js.t Js.prop;
enableLocking : bool Js.t Js.prop; fbar : 'l1. 'l1 Js.t Js.prop;
features : 'b. 'b Js.t Js.prop; fixed : bool Js.t Js.prop;
floatable : bool Js.t Js.prop; floating : bool Js.t Js.prop;
focusOnToFront : bool Js.t Js.prop; forceFit : bool Js.t Js.prop;
formBind : bool Js.t Js.prop; frame : bool Js.t Js.prop;
frameHeader : bool Js.t Js.prop; glyph : 'm1. 'm1 Js.t Js.prop;
header : 'n1. 'n1 Js.t Js.prop;
headerOverCls : Js.js_string Js.t Js.prop;
headerPosition : Js.js_string Js.t Js.prop;
height : Js.number Js.t Js.prop; hidden : bool Js.t Js.prop;
hideCollapseTool : bool Js.t Js.prop; hideHeaders : bool Js.t Js.prop;
hideMode : Js.js_string Js.t Js.prop; html : 'o1. 'o1 Js.t Js.prop;
icon : Js.js_string Js.t Js.prop; iconCls : Js.js_string Js.t Js.prop;
id : Js.js_string Js.t Js.prop;
initComponent : ('i Js.t, unit -> unit) Js.meth_callback
Js.writeonly_prop;
itemId : Js.js_string Js.t Js.prop; items : 'p1. 'p1 Js.t Js.prop;
layout : 'c. 'c Js.t Js.prop; lbar : 'q1. 'q1 Js.t Js.prop;
listeners : 'r1. 'r1 Js.t Js.prop; loader : 's1. 's1 Js.t Js.prop;
lockedGridConfig : 't1. 't1 Js.t Js.prop;
lockedViewConfig : 'u1. 'u1 Js.t Js.prop;
manageHeight : bool Js.t Js.prop; margin : 'v1. 'v1 Js.t Js.prop;
maxHeight : Js.number Js.t Js.prop; maxWidth : Js.number Js.t Js.prop;
minButtonWidth : Js.number Js.t Js.prop;
minHeight : Js.number Js.t Js.prop; minWidth : Js.number Js.t Js.prop;
normalGridConfig : 'w1. 'w1 Js.t Js.prop;
normalViewConfig : 'x1. 'x1 Js.t Js.prop;
onAdd : 'y1.
('i Js.t,
(#Ext_Component.t as 'y1) Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onAdded : 'z1.
('i Js.t, 'z1 Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onBeforeAdd : 'a2.
('i Js.t, (#Ext_Component.t as 'a2) Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onDestroy : ('i Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
onDisable : ('i Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
onDockedAdd : 'b2.
('i Js.t, (#Ext_Component.t as 'b2) Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onDockedRemove : 'c2.
('i Js.t, (#Ext_Component.t as 'c2) Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onEnable : ('i Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop;
onHide : 'd2 'e2 'f2.
('i Js.t,
'd2 Js.t Js.optdef ->
'e2 Js.callback Js.optdef -> 'f2 Js.t Js.optdef -> unit)
Js.meth_callback Js.writeonly_prop;
onPosition : ('i Js.t, Js.number Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onRemove : 'g2.
('i Js.t,
(#Ext_Component.t as 'g2) Js.t -> bool Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onRemoved : ('i Js.t, bool Js.t -> unit) Js.meth_callback
Js.writeonly_prop;
onRender : ('i Js.t, Ext_dom_Element.t Js.t -> Js.number Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onResize : 'h2 'i2 'j2 'k2.
('i Js.t,
'h2 Js.t -> 'i2 Js.t -> 'j2 Js.t -> 'k2 Js.t -> unit)
Js.meth_callback Js.writeonly_prop;
onShow : 'l2 'm2 'n2.
('i Js.t,
'l2 Js.t Js.optdef ->
'm2 Js.callback Js.optdef -> 'n2 Js.t Js.optdef -> unit)
Js.meth_callback Js.writeonly_prop;
onShowComplete : 'o2 'p2.
('i Js.t,
'o2 Js.callback Js.optdef ->
'p2 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; overlapHeader : bool Js.t Js.prop;
padding : 'q2. 'q2 Js.t Js.prop; placeholder : 'r2. 'r2 Js.t Js.prop;
placeholderCollapseHideMode : Js.number Js.t Js.prop;
plugins : 's2. 's2 Js.t Js.prop; rbar : 't2. 't2 Js.t Js.prop;
region : 'u2. 'u2 Js.t Js.prop; renderData : 'v2. 'v2 Js.t Js.prop;
renderSelectors : 'w2. 'w2 Js.t Js.prop;
renderTo : 'x2. 'x2 Js.t Js.prop; renderTpl : 'y2. 'y2 Js.t Js.prop;
resizable : 'z2. 'z2 Js.t Js.prop;
resizeHandles : Js.js_string Js.t Js.prop; rowLines : bool Js.t Js.prop;
rtl : bool Js.t Js.prop; saveDelay : Js.number Js.t Js.prop;
scroll : 'd. 'd Js.t Js.prop; scrollDelta : Js.number Js.t Js.prop;
sealedColumns : bool Js.t Js.prop; selModel : 'e. 'e Js.t Js.prop;
selType : Js.js_string Js.t Js.prop; shadow : 'a3. 'a3 Js.t Js.prop;
shadowOffset : Js.number Js.t Js.prop;
shrinkWrap : 'b3. 'b3 Js.t Js.prop;
shrinkWrapDock : 'c3. 'c3 Js.t Js.prop; simpleDrag : bool Js.t Js.prop;
sortableColumns : 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;
store : Ext_data_Store.t Js.t Js.prop; style : 'd3. 'd3 Js.t Js.prop;
subGridXType : Js.js_string Js.t Js.prop;
suspendLayout : bool Js.t Js.prop; syncRowHeight : bool Js.t Js.prop;
tbar : 'e3. 'e3 Js.t Js.prop; title : Js.js_string Js.t Js.prop;
titleAlign : Js.js_string Js.t Js.prop;
titleCollapse : bool Js.t Js.prop; toFrontOnShow : bool Js.t Js.prop;
tools : 'f3. 'f3 Js.t Js.prop; tpl : 'g3. 'g3 Js.t Js.prop;
tplWriteMode : Js.js_string Js.t Js.prop; ui : Js.js_string Js.t Js.prop;
verticalScroller : 'f. 'f Js.t Js.prop;
view : Ext_view_Table.t Js.t Js.prop; viewConfig : 'g. 'g Js.t Js.prop;
viewType : Js.js_string Js.t Js.prop; width : Js.number Js.t Js.prop;
xtype : Js.js_string Js.t Js.prop; .. >
as 'i)
Js.t, bool Js.t -> unit)
Js.meth_callback Js.writeonly_prop as 'h
t.afterCollapse
method afterExpand : ('i Js.t, bool Js.t -> unit) Js.meth_callback Js.writeonly_prop
t.afterExpand
method beforeDestroy : ('i Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop
t.beforeDestroy
method initComponent : ('i Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop
t.initComponent
method onDestroy : ('i Js.t, unit -> unit) Js.meth_callback Js.writeonly_prop
t.onDestroy