1- # gridstack v13.3 .0
1+ # gridstack v14.0 .0
22
33## Classes
44
@@ -116,7 +116,7 @@ Construct a grid item from the given element and options
116116protected _updateResizeEvent(forceRemove): GridStack;
117117```
118118
119- Defined in: [gridstack.ts:2228 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2228 )
119+ Defined in: [gridstack.ts:2230 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2230 )
120120
121121add or remove the grid element size event handler
122122
@@ -430,7 +430,7 @@ Destroys a grid instance. DO NOT CALL any methods or access any vars after this
430430disable(recurse): GridStack;
431431```
432432
433- Defined in: [gridstack.ts:2443 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2443 )
433+ Defined in: [gridstack.ts:2445 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2445 )
434434
435435Temporarily disables widgets moving/resizing.
436436If you want a more permanent way (which freezes up resources) use `setStatic(true)` instead.
@@ -471,7 +471,7 @@ grid.disable(false);
471471enable(recurse): GridStack;
472472```
473473
474- Defined in: [gridstack.ts:2470 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2470 )
474+ Defined in: [gridstack.ts:2472 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2472 )
475475
476476Re-enables widgets moving/resizing - see disable().
477477Note: This is a no-op for static grids.
@@ -510,7 +510,7 @@ grid.enable(false);
510510enableMove(doEnable, recurse): GridStack;
511511```
512512
513- Defined in: [gridstack.ts:2496 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2496 )
513+ Defined in: [gridstack.ts:2498 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2498 )
514514
515515Enables/disables widget moving for all widgets. No-op for static grids.
516516Note: locally defined items (with noMove property) still override this setting.
@@ -547,7 +547,7 @@ grid.enableMove(true, false);
547547enableResize(doEnable, recurse): GridStack;
548548```
549549
550- Defined in: [gridstack.ts:2524 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2524 )
550+ Defined in: [gridstack.ts:2526 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2526 )
551551
552552Enables/disables widget resizing for all widgets. No-op for static grids.
553553Note: locally defined items (with noResize property) still override this setting.
@@ -659,7 +659,7 @@ const columnCount = grid.getColumn(); // returns 12 by default
659659static getDD(): DDGridStack;
660660```
661661
662- Defined in: [gridstack.ts:2327 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2327 )
662+ Defined in: [gridstack.ts:2329 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2329 )
663663
664664Get the global drag & drop implementation instance.
665665This provides access to the underlying drag & drop functionality.
@@ -709,7 +709,7 @@ items.forEach(item => {
709709getMargin(): number;
710710```
711711
712- Defined in: [gridstack.ts:1857 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1857 )
712+ Defined in: [gridstack.ts:1859 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1859 )
713713
714714Returns the current margin value as a number (undefined if the 4 sides don't match).
715715This only returns a number if all sides have the same margin value.
@@ -1036,7 +1036,7 @@ grid.makeWidget(element, {x: 0, y: 1, w: 4, h: 2});
10361036margin(value): GridStack;
10371037```
10381038
1039- Defined in: [gridstack.ts:1828 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1828 )
1039+ Defined in: [gridstack.ts:1830 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1830 )
10401040
10411041Updates the margins which will set all 4 sides at once - see `GridStackOptions.margin` for format options.
10421042Supports CSS string format of 1, 2, or 4 values or a single number.
@@ -1098,7 +1098,7 @@ grid.mode('list'); // continuous sequential reflow, like a re-orderable list
10981098movable(els, val): GridStack;
10991099```
11001100
1101- Defined in: [gridstack.ts:2384 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2384 )
1101+ Defined in: [gridstack.ts:2386 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2386 )
11021102
11031103Enables/Disables dragging by the user for specific grid elements.
11041104For all items and future items, use enableMove() instead. No-op for static grids.
@@ -1434,7 +1434,7 @@ grid.on('added', (event, items) => {
14341434onResize(clientWidth, clientHeight): GridStack;
14351435```
14361436
1437- Defined in: [gridstack.ts:2163 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2163 )
1437+ Defined in: [gridstack.ts:2165 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2165 )
14381438
14391439called when we are being resized - check if the one Column Mode needs to be turned on/off
14401440and remember the prev columns we used, or get our count from parent, as well as check for cellHeight==='auto' (square)
@@ -1457,7 +1457,7 @@ or `sizeToContent` gridItem options.
14571457prepareDragDrop(el, force?): GridStack;
14581458```
14591459
1460- Defined in: [gridstack.ts:2913 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2913 )
1460+ Defined in: [gridstack.ts:2915 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2915 )
14611461
14621462prepares the element for drag&drop - this is normally called by makeWidget() unless are are delay loading
14631463
@@ -1478,7 +1478,7 @@ prepares the element for drag&drop - this is normally called by makeWidget() unl
14781478refreshDragHandles(els): GridStack;
14791479```
14801480
1481- Defined in: [gridstack.ts:2901 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2901 )
1481+ Defined in: [gridstack.ts:2903 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2903 )
14821482
14831483Re-scans one or more widget elements for drag handle elements after delayed content
14841484(React portal, Angular component, etc.) has been rendered inside the item.
@@ -1599,7 +1599,7 @@ Removes widget from the grid.
15991599resizable(els, val): GridStack;
16001600```
16011601
1602- Defined in: [gridstack.ts:2410 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2410 )
1602+ Defined in: [gridstack.ts:2412 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2412 )
16031603
16041604Enables/Disables user resizing for specific grid elements.
16051605For all items and future items, use enableResize() instead. No-op for static grids.
@@ -1633,7 +1633,7 @@ grid.resizable('#fixed-size-widget', false);
16331633resizeToContent(el): void;
16341634```
16351635
1636- Defined in: [gridstack.ts:1717 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1717 )
1636+ Defined in: [gridstack.ts:1719 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1719 )
16371637
16381638Updates widget height to match the content height to avoid vertical scrollbars or dead space.
16391639This automatically adjusts the widget height based on its content size.
@@ -1669,7 +1669,7 @@ grid.resizeToContent(widget);
16691669rotate(els, relative?): GridStack;
16701670```
16711671
1672- Defined in: [gridstack.ts:1792 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1792 )
1672+ Defined in: [gridstack.ts:1794 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1794 )
16731673
16741674Rotate widgets by swapping their width and height. This is typically called when the user presses 'r' during dragging.
16751675The rotation swaps the w/h dimensions and adjusts min/max constraints accordingly.
@@ -1786,7 +1786,7 @@ static setupDragIn(
17861786 root?): void;
17871787```
17881788
1789- Defined in: [gridstack.ts:2340 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2340 )
1789+ Defined in: [gridstack.ts:2342 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2342 )
17901790
17911791call to setup dragging in from the outside (say toolbar), by specifying the class selection and options.
17921792Called during GridStack.init() as options, but can also be called directly (last param are used) in case the toolbar
@@ -1811,7 +1811,7 @@ is dynamically create and needs to be set later.
18111811protected triggerEvent(event, target): void;
18121812```
18131813
1814- Defined in: [gridstack.ts:3175 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L3175 )
1814+ Defined in: [gridstack.ts:3177 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L3177 )
18151815
18161816call given event callback on our main top-most grid (if we're nested)
18171817
@@ -1897,7 +1897,7 @@ Updates the passed in options on the grid (similar to update(widget) for for the
18971897willItFit(node): boolean;
18981898```
18991899
1900- Defined in: [gridstack.ts:1871 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1871 )
1900+ Defined in: [gridstack.ts:1873 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1873 )
19011901
19021902Returns true if the height of the grid will be less than the vertical
19031903constraint. Always returns true if grid doesn't have height constraint.
@@ -2133,7 +2133,7 @@ engine.batchUpdate(false); // Apply all changes at once
21332133beginUpdate(node): GridStackEngine;
21342134```
21352135
2136- Defined in: [gridstack-engine.ts:1065 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1065 )
2136+ Defined in: [gridstack-engine.ts:1069 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1069 )
21372137
21382138###### Parameters
21392139
@@ -2154,7 +2154,7 @@ cacheLayout(
21542154 clear): GridStackEngine;
21552155```
21562156
2157- Defined in: [gridstack-engine.ts:1275 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1275 )
2157+ Defined in: [gridstack-engine.ts:1279 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1279 )
21582158
21592159call to cache the given layout internally to the given location so we can restore back when column changes size
21602160
@@ -2176,7 +2176,7 @@ call to cache the given layout internally to the given location so we can restor
21762176cacheOneLayout(n, column): GridStackEngine;
21772177```
21782178
2179- Defined in: [gridstack-engine.ts:1295 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1295 )
2179+ Defined in: [gridstack-engine.ts:1299 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1299 )
21802180
21812181call to cache the given node layout internally to the given location so we can restore back when column changes size
21822182
@@ -2197,7 +2197,7 @@ call to cache the given node layout internally to the given location so we can r
21972197changedPosConstrain(node, p): boolean;
21982198```
21992199
2200- Defined in: [gridstack-engine.ts:969 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L969 )
2200+ Defined in: [gridstack-engine.ts:973 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L973 )
22012201
22022202true if x,y or w,h are different after clamping to min/max
22032203
@@ -2218,7 +2218,7 @@ true if x,y or w,h are different after clamping to min/max
22182218cleanupNode(node): GridStackEngine;
22192219```
22202220
2221- Defined in: [gridstack-engine.ts:1326 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1326 )
2221+ Defined in: [gridstack-engine.ts:1330 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1330 )
22222222
22232223called to remove all internal values but the _id
22242224
@@ -2369,7 +2369,7 @@ does a pixel coverage collision based on where we started, returning the node th
23692369endUpdate(): GridStackEngine;
23702370```
23712371
2372- Defined in: [gridstack-engine.ts:1074 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1074 )
2372+ Defined in: [gridstack-engine.ts:1078 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1078 )
23732373
23742374###### Returns
23752375
@@ -2381,7 +2381,7 @@ Defined in: [gridstack-engine.ts:1074](https://github.com/adumesny/gridstack.js/
23812381protected findCacheLayout(n, column): number;
23822382```
23832383
2384- Defined in: [gridstack-engine.ts:1309 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1309 )
2384+ Defined in: [gridstack-engine.ts:1313 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1313 )
23852385
23862386###### Parameters
23872387
@@ -2472,7 +2472,7 @@ const verified = engine.getDirtyNodes(true);
24722472getRow(): number;
24732473```
24742474
2475- Defined in: [gridstack-engine.ts:1061 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1061 )
2475+ Defined in: [gridstack-engine.ts:1065 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1065 )
24762476
24772477###### Returns
24782478
@@ -2521,7 +2521,7 @@ if (engine.isAreaEmpty(2, 1, 3, 2)) {
25212521moveNode(node, o): boolean;
25222522```
25232523
2524- Defined in: [gridstack-engine.ts:983 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L983 )
2524+ Defined in: [gridstack-engine.ts:987 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L987 )
25252525
25262526return true if the passed in node was actually moved (checks for no-op and locked)
25272527
@@ -2704,7 +2704,7 @@ engine.removeNode(node, true, true);
27042704removeNodeFromLayoutCache(n): void;
27052705```
27062706
2707- Defined in: [gridstack-engine.ts:1313 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1313 )
2707+ Defined in: [gridstack-engine.ts:1317 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1317 )
27082708
27092709###### Parameters
27102710
@@ -2725,7 +2725,7 @@ save(
27252725 column?): GridStackNode[];
27262726```
27272727
2728- Defined in: [gridstack-engine.ts:1092 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1092 )
2728+ Defined in: [gridstack-engine.ts:1096 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1096 )
27292729
27302730saves a copy of the largest column layout (eg 12 even when rendering 1 column) so we don't loose orig layout, unless explicity column
27312731count to use is given. returning a list of widgets for serialization
@@ -2811,7 +2811,7 @@ if (swapped) {
28112811willItFit(node): boolean;
28122812```
28132813
2814- Defined in: [gridstack-engine.ts:936 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L936 )
2814+ Defined in: [gridstack-engine.ts:940 ](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L940 )
28152815
28162816return true if can fit in grid height constrain only (always true if no maxRow)
28172817
0 commit comments