-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #377 from sencha/REAC-395-APIDocsUpdate
REAC-395-Updated docs.
- Loading branch information
Showing
14 changed files
with
841 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /** | ||
| * Produces no value for a summary. This would be used for fields like `id` or other | ||
| * value that does not aggregate. | ||
| * @since 7.0 | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Mixed} value | ||
| * The value to report for the summary. | ||
| */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| /** | ||
| * @class Ext.grid.locked.Grid | ||
| * @extend Ext.Panel | ||
| * @xtype lockedgrid | ||
| * @alternateClassName Ext.grid.LockedGrid | ||
| * @isLockedGrid true | ||
| * The `lockedgrid` component manages one or more child `grid`s that independently scroll | ||
| * in the horizontal axis but are vertically synchronized. The end-user can, using column | ||
| * menus or drag-drop, control which of these {@link #cfg!regions regions} contain which | ||
| * columns. | ||
| * | ||
| * ## Locked Regions | ||
| * | ||
| * The `lockedgrid` always has a `center` {@link Ext.grid.locked.Region region} and by | ||
| * default a `left` and `right` region. These regions are derivatives of `Ext.panel.Panel` | ||
| * (to allow them to be resized and collapsed) and contain normal `grid` with a subset of | ||
| * the overall set of `columns`. All keys in the `regions` config object are valid values | ||
| * for a {@link Ext.grid.column.Column column}'s `locked` config. The values of each of | ||
| * the properties of the `regions` config are configurations for the locked region itself. | ||
| * | ||
| * The layout of the locked regions is a simple `hbox` with the `center` assigned `flex:1` | ||
| * and the non-center regions assigned a width based on the columns contained in that | ||
| * region. The order of items in the container is determined by the `weight` assigned to | ||
| * each region. Regions to the left of center have negative `weight` values, while regions | ||
| * to the right of center have positive `weight` values. This distinction is important | ||
| * primarily to determine the side of the region on which to display the resizer as well | ||
| * as setting the direction of collapse for the region. | ||
| * | ||
| * ## Config and Event Delegation | ||
| * | ||
| * The `lockedgrid` mimics the config properties and events fired by a normal `grid`. It | ||
| * does this in some cases by delegating configs to each child grid. The `regions` config | ||
| * should be used to listen to events or configure a child grid independently when this | ||
| * isn't desired. | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Object} columnMenu | ||
| * This is a config object which is used by columns in this grid to create their | ||
| * header menus. | ||
| * | ||
| * The following column menu contains the following items. | ||
| * | ||
| * - Default column menu items {@link Ext.grid.Grid grid} | ||
| * - "Region" menu item to provide locking sub-menu options | ||
| * | ||
| * This can be configured as `null` to prevent columns from showing a column menu. | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Ext.grid.column.Column[]} columns (required) | ||
| * 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. | ||
| * Column definition can also define the locked property | ||
| * | ||
| * 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", | ||
| * locked: true, | ||
| * width: 200 | ||
| * },{ | ||
| * text: "Column B", | ||
| * dataIndex: "field_B", | ||
| * width: 150 | ||
| * }, | ||
| * ... | ||
| * ] | ||
| * } | ||
| * | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {String} defaultLockedRegion | ||
| * This config determines which region corresponds to `locked: true` on a column. | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Object} gridDefaults | ||
| * This config is applied to the child `grid` in all regions. | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Boolean} hideHeaders | ||
| * @inheritdoc Ext.grid.Grid#cfg!hideHeaders | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Object} itemConfig | ||
| * @inheritdoc Ext.grid.Grid#cfg!itemConfig | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Object} leftGridDefaults | ||
| * This config is applied to the child `grid` in all left-side regions (those of | ||
| * negative `weight`) | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Object} regions | ||
| * This config determines the set of possible locked regions. Each key name in this | ||
| * object denotes a named region (for example, "left", "right" and "center"). While | ||
| * the set of names is not fixed, meaning a `lockedgrid` can have more than these | ||
| * three regions, there must always be a "center" region. The center regions cannot | ||
| * be hidden or collapsed or emptied of all columns. | ||
| * | ||
| * The values of each property in this object are configuration objects for the | ||
| * {@link Ext.grid.locked.Region region}. The ordering of grids is determined by | ||
| * the `weight` config. Negative values are "left" regions, while positive values | ||
| * are "right" regions. The `menuLabel` is used in the column menu to allow the user | ||
| * to place columns into the region. | ||
| * | ||
| * To add an additional left region: | ||
| * | ||
| * xtype: 'lockedgrid', | ||
| * regions: { | ||
| * left2: { | ||
| * menuLabel: 'Locked (leftmost)', | ||
| * weight: -20 // to the left of the standard "left" region | ||
| * } | ||
| * } | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Object} rightGridDefaults | ||
| * This config is applied to the child `grid` in all right-side regions (those of | ||
| * positive `weight`) | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Ext.data.Store/Object/String} store | ||
| * @inheritdoc Ext.grid.Grid#cfg!store | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Boolean} variableHeights | ||
| * @inheritdoc Ext.grid.Grid#cfg!variableHeights | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Boolean} enableColumnMove | ||
| * Set to `false` to disable header reorder within this grid. | ||
| */ | ||
|
|
||
| /** | ||
| * @cfg {Boolean} grouped | ||
| * @inheritdoc Ext.dataview.List#cfg!grouped | ||
| */ |
Oops, something went wrong.