gridstack 12.3.2 → 12.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/angular/esm2020/lib/base-widget.mjs +2 -2
- package/dist/angular/esm2020/lib/gridstack-item.component.mjs +2 -2
- package/dist/angular/esm2020/lib/gridstack.component.mjs +4 -2
- package/dist/angular/esm2020/lib/gridstack.module.mjs +2 -2
- package/dist/angular/esm2020/lib/types.mjs +2 -2
- package/dist/angular/fesm2015/gridstack-angular.mjs +6 -4
- package/dist/angular/fesm2015/gridstack-angular.mjs.map +1 -1
- package/dist/angular/fesm2020/gridstack-angular.mjs +7 -5
- package/dist/angular/fesm2020/gridstack-angular.mjs.map +1 -1
- package/dist/angular/lib/gridstack-item.component.d.ts +1 -1
- package/dist/angular/lib/gridstack.component.d.ts +4 -4
- package/dist/angular/lib/types.d.ts +1 -1
- package/dist/angular/package.json +1 -1
- package/dist/angular/projects/lib/src/index.d.ts +5 -0
- package/dist/angular/projects/lib/src/index.js +9 -0
- package/dist/angular/projects/lib/src/index.js.map +1 -0
- package/dist/angular/projects/lib/src/lib/base-widget.d.ts +56 -0
- package/dist/angular/projects/lib/src/lib/base-widget.js +94 -0
- package/dist/angular/projects/lib/src/lib/base-widget.js.map +1 -0
- package/dist/angular/projects/lib/src/lib/gridstack-item.component.d.ts +76 -0
- package/dist/angular/projects/lib/src/lib/gridstack-item.component.js +112 -0
- package/dist/angular/projects/lib/src/lib/gridstack-item.component.js.map +1 -0
- package/dist/angular/projects/lib/src/lib/gridstack.component.d.ts +233 -0
- package/dist/angular/projects/lib/src/lib/gridstack.component.js +457 -0
- package/dist/angular/projects/lib/src/lib/gridstack.component.js.map +1 -0
- package/dist/angular/projects/lib/src/lib/gridstack.module.d.ts +29 -0
- package/dist/angular/projects/lib/src/lib/gridstack.module.js +52 -0
- package/dist/angular/projects/lib/src/lib/gridstack.module.js.map +1 -0
- package/dist/angular/projects/lib/src/lib/types.d.ts +51 -0
- package/dist/angular/projects/lib/src/lib/types.js +6 -0
- package/dist/angular/projects/lib/src/lib/types.js.map +1 -0
- package/dist/angular/src/base-widget.ts +13 -13
- package/dist/angular/src/gridstack-item.component.ts +5 -5
- package/dist/angular/src/gridstack.component.ts +34 -32
- package/dist/angular/src/gridstack.module.ts +4 -4
- package/dist/angular/src/types.ts +3 -2
- package/dist/gridstack-all.js +1 -1
- package/dist/gridstack-all.js.LICENSE.txt +1 -1
- package/dist/gridstack-all.js.map +1 -1
- package/dist/gridstack.css +1 -1
- package/dist/{dd-base-impl.d.ts → src/dd-base-impl.d.ts} +1 -1
- package/dist/{dd-base-impl.js → src/dd-base-impl.js} +1 -1
- package/dist/src/dd-base-impl.js.map +1 -0
- package/dist/{dd-draggable.d.ts → src/dd-draggable.d.ts} +1 -1
- package/dist/{dd-draggable.js → src/dd-draggable.js} +1 -1
- package/dist/src/dd-draggable.js.map +1 -0
- package/dist/{dd-droppable.d.ts → src/dd-droppable.d.ts} +1 -1
- package/dist/{dd-droppable.js → src/dd-droppable.js} +7 -1
- package/dist/src/dd-droppable.js.map +1 -0
- package/dist/{dd-element.d.ts → src/dd-element.d.ts} +1 -1
- package/dist/{dd-element.js → src/dd-element.js} +1 -1
- package/dist/src/dd-element.js.map +1 -0
- package/dist/{dd-gridstack.d.ts → src/dd-gridstack.d.ts} +1 -1
- package/dist/{dd-gridstack.js → src/dd-gridstack.js} +1 -1
- package/dist/src/dd-gridstack.js.map +1 -0
- package/dist/{dd-manager.d.ts → src/dd-manager.d.ts} +1 -1
- package/dist/{dd-manager.js → src/dd-manager.js} +1 -1
- package/dist/src/dd-manager.js.map +1 -0
- package/dist/{dd-resizable-handle.d.ts → src/dd-resizable-handle.d.ts} +5 -4
- package/dist/{dd-resizable-handle.js → src/dd-resizable-handle.js} +23 -8
- package/dist/src/dd-resizable-handle.js.map +1 -0
- package/dist/{dd-resizable.d.ts → src/dd-resizable.d.ts} +3 -5
- package/dist/{dd-resizable.js → src/dd-resizable.js} +5 -10
- package/dist/src/dd-resizable.js.map +1 -0
- package/dist/{dd-touch.d.ts → src/dd-touch.d.ts} +1 -1
- package/dist/{dd-touch.js → src/dd-touch.js} +1 -1
- package/dist/src/dd-touch.js.map +1 -0
- package/dist/{gridstack-engine.d.ts → src/gridstack-engine.d.ts} +1 -1
- package/dist/{gridstack-engine.js → src/gridstack-engine.js} +7 -1
- package/dist/src/gridstack-engine.js.map +1 -0
- package/dist/{gridstack.d.ts → src/gridstack.d.ts} +1 -2
- package/dist/{gridstack.js → src/gridstack.js} +9 -18
- package/dist/src/gridstack.js.map +1 -0
- package/dist/src/gridstack.scss +1 -1
- package/dist/{types.d.ts → src/types.d.ts} +11 -6
- package/dist/{types.js → src/types.js} +1 -1
- package/dist/src/types.js.map +1 -0
- package/dist/src/utils.d.ts +14 -0
- package/dist/{utils.js → src/utils.js} +40 -31
- package/dist/src/utils.js.map +1 -0
- package/doc/API.md +174 -173
- package/package.json +24 -12
- package/dist/dd-base-impl.js.map +0 -1
- package/dist/dd-draggable.js.map +0 -1
- package/dist/dd-droppable.js.map +0 -1
- package/dist/dd-element.js.map +0 -1
- package/dist/dd-gridstack.js.map +0 -1
- package/dist/dd-manager.js.map +0 -1
- package/dist/dd-resizable-handle.js.map +0 -1
- package/dist/dd-resizable.js.map +0 -1
- package/dist/dd-touch.js.map +0 -1
- package/dist/gridstack-engine.js.map +0 -1
- package/dist/gridstack.js.map +0 -1
- package/dist/types.js.map +0 -1
- package/dist/utils.d.ts +0 -283
- package/dist/utils.js.map +0 -1
package/doc/API.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# gridstack v12.
|
|
1
|
+
# gridstack v12.4.0
|
|
2
2
|
|
|
3
3
|
## Classes
|
|
4
4
|
|
|
@@ -113,7 +113,7 @@ Construct a grid item from the given element and options
|
|
|
113
113
|
protected _updateResizeEvent(forceRemove): GridStack;
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
Defined in: [gridstack.ts:
|
|
116
|
+
Defined in: [gridstack.ts:2085](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2085)
|
|
117
117
|
|
|
118
118
|
add or remove the grid element size event handler
|
|
119
119
|
|
|
@@ -133,7 +133,7 @@ add or remove the grid element size event handler
|
|
|
133
133
|
protected _widthOrContainer(forBreakpoint): number;
|
|
134
134
|
```
|
|
135
135
|
|
|
136
|
-
Defined in: [gridstack.ts:
|
|
136
|
+
Defined in: [gridstack.ts:955](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L955)
|
|
137
137
|
|
|
138
138
|
return our expected width (or parent) , and optionally of window for dynamic column check
|
|
139
139
|
|
|
@@ -286,7 +286,7 @@ const widgetWidth = width * 3; // For a 3-column wide widget
|
|
|
286
286
|
protected checkDynamicColumn(): boolean;
|
|
287
287
|
```
|
|
288
288
|
|
|
289
|
-
Defined in: [gridstack.ts:
|
|
289
|
+
Defined in: [gridstack.ts:962](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L962)
|
|
290
290
|
|
|
291
291
|
checks for dynamic column count for our current size, returning true if changed
|
|
292
292
|
|
|
@@ -300,7 +300,7 @@ checks for dynamic column count for our current size, returning true if changed
|
|
|
300
300
|
column(column, layout): GridStack;
|
|
301
301
|
```
|
|
302
302
|
|
|
303
|
-
Defined in: [gridstack.ts:
|
|
303
|
+
Defined in: [gridstack.ts:1041](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1041)
|
|
304
304
|
|
|
305
305
|
Set the number of columns in the grid. Will update existing widgets to conform to new number of columns,
|
|
306
306
|
as well as cache the original layout so you can revert back to previous positions without loss.
|
|
@@ -335,25 +335,13 @@ grid.column(4, 'move');
|
|
|
335
335
|
grid.column(1);
|
|
336
336
|
```
|
|
337
337
|
|
|
338
|
-
##### commit()
|
|
339
|
-
|
|
340
|
-
```ts
|
|
341
|
-
commit(): GridStack;
|
|
342
|
-
```
|
|
343
|
-
|
|
344
|
-
Defined in: [gridstack.ts:3020](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L3020)
|
|
345
|
-
|
|
346
|
-
###### Returns
|
|
347
|
-
|
|
348
|
-
[`GridStack`](#gridstack-1)
|
|
349
|
-
|
|
350
338
|
##### compact()
|
|
351
339
|
|
|
352
340
|
```ts
|
|
353
341
|
compact(layout, doSort): GridStack;
|
|
354
342
|
```
|
|
355
343
|
|
|
356
|
-
Defined in: [gridstack.ts:
|
|
344
|
+
Defined in: [gridstack.ts:1007](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1007)
|
|
357
345
|
|
|
358
346
|
Re-layout grid items to reclaim any empty space. This is useful after removing widgets
|
|
359
347
|
or when you want to optimize the layout.
|
|
@@ -419,7 +407,7 @@ const element = grid.createWidgetDivs({ w: 2, h: 1, content: 'Hello World' });
|
|
|
419
407
|
destroy(removeDOM): GridStack;
|
|
420
408
|
```
|
|
421
409
|
|
|
422
|
-
Defined in: [gridstack.ts:
|
|
410
|
+
Defined in: [gridstack.ts:1115](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1115)
|
|
423
411
|
|
|
424
412
|
Destroys a grid instance. DO NOT CALL any methods or access any vars after this as it will free up members.
|
|
425
413
|
|
|
@@ -439,7 +427,7 @@ Destroys a grid instance. DO NOT CALL any methods or access any vars after this
|
|
|
439
427
|
disable(recurse): GridStack;
|
|
440
428
|
```
|
|
441
429
|
|
|
442
|
-
Defined in: [gridstack.ts:
|
|
430
|
+
Defined in: [gridstack.ts:2286](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2286)
|
|
443
431
|
|
|
444
432
|
Temporarily disables widgets moving/resizing.
|
|
445
433
|
If you want a more permanent way (which freezes up resources) use `setStatic(true)` instead.
|
|
@@ -480,7 +468,7 @@ grid.disable(false);
|
|
|
480
468
|
enable(recurse): GridStack;
|
|
481
469
|
```
|
|
482
470
|
|
|
483
|
-
Defined in: [gridstack.ts:
|
|
471
|
+
Defined in: [gridstack.ts:2313](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2313)
|
|
484
472
|
|
|
485
473
|
Re-enables widgets moving/resizing - see disable().
|
|
486
474
|
Note: This is a no-op for static grids.
|
|
@@ -519,7 +507,7 @@ grid.enable(false);
|
|
|
519
507
|
enableMove(doEnable, recurse): GridStack;
|
|
520
508
|
```
|
|
521
509
|
|
|
522
|
-
Defined in: [gridstack.ts:
|
|
510
|
+
Defined in: [gridstack.ts:2339](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2339)
|
|
523
511
|
|
|
524
512
|
Enables/disables widget moving for all widgets. No-op for static grids.
|
|
525
513
|
Note: locally defined items (with noMove property) still override this setting.
|
|
@@ -556,7 +544,7 @@ grid.enableMove(true, false);
|
|
|
556
544
|
enableResize(doEnable, recurse): GridStack;
|
|
557
545
|
```
|
|
558
546
|
|
|
559
|
-
Defined in: [gridstack.ts:
|
|
547
|
+
Defined in: [gridstack.ts:2367](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2367)
|
|
560
548
|
|
|
561
549
|
Enables/disables widget resizing for all widgets. No-op for static grids.
|
|
562
550
|
Note: locally defined items (with noResize property) still override this setting.
|
|
@@ -593,7 +581,7 @@ grid.enableResize(true, false);
|
|
|
593
581
|
float(val): GridStack;
|
|
594
582
|
```
|
|
595
583
|
|
|
596
|
-
Defined in: [gridstack.ts:
|
|
584
|
+
Defined in: [gridstack.ts:1149](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1149)
|
|
597
585
|
|
|
598
586
|
Enable/disable floating widgets (default: `false`). When enabled, widgets can float up to fill empty spaces.
|
|
599
587
|
See [example](http://gridstackjs.com/demo/float.html)
|
|
@@ -623,7 +611,7 @@ grid.float(false); // Disable floating (default)
|
|
|
623
611
|
getCellFromPixel(position, useDocRelative): CellPosition;
|
|
624
612
|
```
|
|
625
613
|
|
|
626
|
-
Defined in: [gridstack.ts:
|
|
614
|
+
Defined in: [gridstack.ts:1179](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1179)
|
|
627
615
|
|
|
628
616
|
Get the position of the cell under a pixel on screen.
|
|
629
617
|
|
|
@@ -676,7 +664,7 @@ const pixelHeight = grid.getCellHeight(true);
|
|
|
676
664
|
getColumn(): number;
|
|
677
665
|
```
|
|
678
666
|
|
|
679
|
-
Defined in: [gridstack.ts:
|
|
667
|
+
Defined in: [gridstack.ts:1078](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1078)
|
|
680
668
|
|
|
681
669
|
Get the number of columns in the grid (default 12).
|
|
682
670
|
|
|
@@ -698,7 +686,7 @@ const columnCount = grid.getColumn(); // returns 12 by default
|
|
|
698
686
|
static getDD(): DDGridStack;
|
|
699
687
|
```
|
|
700
688
|
|
|
701
|
-
Defined in: [gridstack.ts:
|
|
689
|
+
Defined in: [gridstack.ts:2183](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2183)
|
|
702
690
|
|
|
703
691
|
Get the global drag & drop implementation instance.
|
|
704
692
|
This provides access to the underlying drag & drop functionality.
|
|
@@ -722,7 +710,7 @@ const dd = GridStack.getDD();
|
|
|
722
710
|
getFloat(): boolean;
|
|
723
711
|
```
|
|
724
712
|
|
|
725
|
-
Defined in: [gridstack.ts:
|
|
713
|
+
Defined in: [gridstack.ts:1166](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1166)
|
|
726
714
|
|
|
727
715
|
Get the current float mode setting.
|
|
728
716
|
|
|
@@ -745,7 +733,7 @@ console.log('Floating enabled:', isFloating);
|
|
|
745
733
|
getGridItems(): GridItemHTMLElement[];
|
|
746
734
|
```
|
|
747
735
|
|
|
748
|
-
Defined in: [gridstack.ts:
|
|
736
|
+
Defined in: [gridstack.ts:1092](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1092)
|
|
749
737
|
|
|
750
738
|
Returns an array of grid HTML elements (no placeholder) - used to iterate through our children in DOM order.
|
|
751
739
|
This method excludes placeholder elements and returns only actual grid items.
|
|
@@ -771,7 +759,7 @@ items.forEach(item => {
|
|
|
771
759
|
getMargin(): number;
|
|
772
760
|
```
|
|
773
761
|
|
|
774
|
-
Defined in: [gridstack.ts:
|
|
762
|
+
Defined in: [gridstack.ts:1791](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1791)
|
|
775
763
|
|
|
776
764
|
Returns the current margin value as a number (undefined if the 4 sides don't match).
|
|
777
765
|
This only returns a number if all sides have the same margin value.
|
|
@@ -799,7 +787,7 @@ if (margin !== undefined) {
|
|
|
799
787
|
getRow(): number;
|
|
800
788
|
```
|
|
801
789
|
|
|
802
|
-
Defined in: [gridstack.ts:
|
|
790
|
+
Defined in: [gridstack.ts:1209](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1209)
|
|
803
791
|
|
|
804
792
|
Returns the current number of rows, which will be at least `minRow` if set.
|
|
805
793
|
The row count is based on the highest positioned widget in the grid.
|
|
@@ -887,7 +875,7 @@ isAreaEmpty(
|
|
|
887
875
|
h): boolean;
|
|
888
876
|
```
|
|
889
877
|
|
|
890
|
-
Defined in: [gridstack.ts:
|
|
878
|
+
Defined in: [gridstack.ts:1228](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1228)
|
|
891
879
|
|
|
892
880
|
Checks if the specified rectangular area is empty (no widgets occupy any part of it).
|
|
893
881
|
|
|
@@ -921,7 +909,7 @@ if (grid.isAreaEmpty(1, 1, 2, 2)) {
|
|
|
921
909
|
isIgnoreChangeCB(): boolean;
|
|
922
910
|
```
|
|
923
911
|
|
|
924
|
-
Defined in: [gridstack.ts:
|
|
912
|
+
Defined in: [gridstack.ts:1109](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1109)
|
|
925
913
|
|
|
926
914
|
Returns true if change callbacks should be ignored due to column change, sizeToContent, loading, etc.
|
|
927
915
|
This is useful for callers who want to implement dirty flag functionality.
|
|
@@ -1032,7 +1020,7 @@ newly created grid
|
|
|
1032
1020
|
makeWidget(els, options?): GridItemHTMLElement;
|
|
1033
1021
|
```
|
|
1034
1022
|
|
|
1035
|
-
Defined in: [gridstack.ts:
|
|
1023
|
+
Defined in: [gridstack.ts:1256](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1256)
|
|
1036
1024
|
|
|
1037
1025
|
If you add elements to your grid by hand (or have some framework creating DOM), you have to tell gridstack afterwards to make them widgets.
|
|
1038
1026
|
If you want gridstack to add the elements for you, use `addWidget()` instead.
|
|
@@ -1075,7 +1063,7 @@ grid.makeWidget(element, {x: 0, y: 1, w: 4, h: 2});
|
|
|
1075
1063
|
margin(value): GridStack;
|
|
1076
1064
|
```
|
|
1077
1065
|
|
|
1078
|
-
Defined in: [gridstack.ts:
|
|
1066
|
+
Defined in: [gridstack.ts:1762](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1762)
|
|
1079
1067
|
|
|
1080
1068
|
Updates the margins which will set all 4 sides at once - see `GridStackOptions.margin` for format options.
|
|
1081
1069
|
Supports CSS string format of 1, 2, or 4 values or a single number.
|
|
@@ -1106,12 +1094,12 @@ grid.margin('5px 10px 15px 20px'); // Different for each side
|
|
|
1106
1094
|
movable(els, val): GridStack;
|
|
1107
1095
|
```
|
|
1108
1096
|
|
|
1109
|
-
Defined in: [gridstack.ts:
|
|
1097
|
+
Defined in: [gridstack.ts:2227](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2227)
|
|
1110
1098
|
|
|
1111
|
-
Enables/Disables dragging by the user for specific grid elements.
|
|
1099
|
+
Enables/Disables dragging by the user for specific grid elements.
|
|
1112
1100
|
For all items and future items, use enableMove() instead. No-op for static grids.
|
|
1113
1101
|
|
|
1114
|
-
Note: If you want to prevent an item from moving due to being pushed around by another
|
|
1102
|
+
Note: If you want to prevent an item from moving due to being pushed around by another
|
|
1115
1103
|
during collision, use the 'locked' property instead.
|
|
1116
1104
|
|
|
1117
1105
|
###### Parameters
|
|
@@ -1143,7 +1131,7 @@ grid.movable('#fixed-widget', false);
|
|
|
1143
1131
|
off(name): GridStack;
|
|
1144
1132
|
```
|
|
1145
1133
|
|
|
1146
|
-
Defined in: [gridstack.ts:
|
|
1134
|
+
Defined in: [gridstack.ts:1352](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1352)
|
|
1147
1135
|
|
|
1148
1136
|
unsubscribe from the 'on' event GridStackEvent
|
|
1149
1137
|
|
|
@@ -1163,7 +1151,7 @@ unsubscribe from the 'on' event GridStackEvent
|
|
|
1163
1151
|
offAll(): GridStack;
|
|
1164
1152
|
```
|
|
1165
1153
|
|
|
1166
|
-
Defined in: [gridstack.ts:
|
|
1154
|
+
Defined in: [gridstack.ts:1379](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1379)
|
|
1167
1155
|
|
|
1168
1156
|
Remove all event handlers from the grid. This is useful for cleanup when destroying a grid.
|
|
1169
1157
|
|
|
@@ -1187,7 +1175,7 @@ grid.offAll(); // Remove all event listeners
|
|
|
1187
1175
|
on(name, callback): GridStack;
|
|
1188
1176
|
```
|
|
1189
1177
|
|
|
1190
|
-
Defined in: [gridstack.ts:
|
|
1178
|
+
Defined in: [gridstack.ts:1315](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1315)
|
|
1191
1179
|
|
|
1192
1180
|
Register event handler for grid events. You can call this on a single event name, or space separated list.
|
|
1193
1181
|
|
|
@@ -1238,7 +1226,7 @@ grid.on('added', (event, items) => {
|
|
|
1238
1226
|
on(name, callback): GridStack;
|
|
1239
1227
|
```
|
|
1240
1228
|
|
|
1241
|
-
Defined in: [gridstack.ts:
|
|
1229
|
+
Defined in: [gridstack.ts:1316](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1316)
|
|
1242
1230
|
|
|
1243
1231
|
Register event handler for grid events. You can call this on a single event name, or space separated list.
|
|
1244
1232
|
|
|
@@ -1289,7 +1277,7 @@ grid.on('added', (event, items) => {
|
|
|
1289
1277
|
on(name, callback): GridStack;
|
|
1290
1278
|
```
|
|
1291
1279
|
|
|
1292
|
-
Defined in: [gridstack.ts:
|
|
1280
|
+
Defined in: [gridstack.ts:1317](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1317)
|
|
1293
1281
|
|
|
1294
1282
|
Register event handler for grid events. You can call this on a single event name, or space separated list.
|
|
1295
1283
|
|
|
@@ -1311,7 +1299,7 @@ Supported events:
|
|
|
1311
1299
|
|
|
1312
1300
|
| Parameter | Type | Description |
|
|
1313
1301
|
| ------ | ------ | ------ |
|
|
1314
|
-
| `name` | `"
|
|
1302
|
+
| `name` | `"change"` \| `"added"` \| `"removed"` \| `"resizecontent"` | event name(s) to listen for (space separated for multiple) |
|
|
1315
1303
|
| `callback` | [`GridStackNodesHandler`](#gridstacknodeshandler) | function to call when event occurs |
|
|
1316
1304
|
|
|
1317
1305
|
###### Returns
|
|
@@ -1340,7 +1328,7 @@ grid.on('added', (event, items) => {
|
|
|
1340
1328
|
on(name, callback): GridStack;
|
|
1341
1329
|
```
|
|
1342
1330
|
|
|
1343
|
-
Defined in: [gridstack.ts:
|
|
1331
|
+
Defined in: [gridstack.ts:1318](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1318)
|
|
1344
1332
|
|
|
1345
1333
|
Register event handler for grid events. You can call this on a single event name, or space separated list.
|
|
1346
1334
|
|
|
@@ -1362,7 +1350,7 @@ Supported events:
|
|
|
1362
1350
|
|
|
1363
1351
|
| Parameter | Type | Description |
|
|
1364
1352
|
| ------ | ------ | ------ |
|
|
1365
|
-
| `name` | \| `"
|
|
1353
|
+
| `name` | \| `"drag"` \| `"dragstart"` \| `"resize"` \| `"resizestart"` \| `"resizestop"` \| `"dragstop"` | event name(s) to listen for (space separated for multiple) |
|
|
1366
1354
|
| `callback` | [`GridStackElementHandler`](#gridstackelementhandler) | function to call when event occurs |
|
|
1367
1355
|
|
|
1368
1356
|
###### Returns
|
|
@@ -1391,7 +1379,7 @@ grid.on('added', (event, items) => {
|
|
|
1391
1379
|
on(name, callback): GridStack;
|
|
1392
1380
|
```
|
|
1393
1381
|
|
|
1394
|
-
Defined in: [gridstack.ts:
|
|
1382
|
+
Defined in: [gridstack.ts:1319](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1319)
|
|
1395
1383
|
|
|
1396
1384
|
Register event handler for grid events. You can call this on a single event name, or space separated list.
|
|
1397
1385
|
|
|
@@ -1442,7 +1430,7 @@ grid.on('added', (event, items) => {
|
|
|
1442
1430
|
onResize(clientWidth): GridStack;
|
|
1443
1431
|
```
|
|
1444
1432
|
|
|
1445
|
-
Defined in: [gridstack.ts:
|
|
1433
|
+
Defined in: [gridstack.ts:2024](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2024)
|
|
1446
1434
|
|
|
1447
1435
|
called when we are being resized - check if the one Column Mode needs to be turned on/off
|
|
1448
1436
|
and remember the prev columns we used, or get our count from parent, as well as check for cellHeight==='auto' (square)
|
|
@@ -1464,7 +1452,7 @@ or `sizeToContent` gridItem options.
|
|
|
1464
1452
|
prepareDragDrop(el, force?): GridStack;
|
|
1465
1453
|
```
|
|
1466
1454
|
|
|
1467
|
-
Defined in: [gridstack.ts:
|
|
1455
|
+
Defined in: [gridstack.ts:2710](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2710)
|
|
1468
1456
|
|
|
1469
1457
|
prepares the element for drag&drop - this is normally called by makeWidget() unless are are delay loading
|
|
1470
1458
|
|
|
@@ -1507,7 +1495,7 @@ replace just one instance.
|
|
|
1507
1495
|
removeAll(removeDOM, triggerEvent): GridStack;
|
|
1508
1496
|
```
|
|
1509
1497
|
|
|
1510
|
-
Defined in: [gridstack.ts:
|
|
1498
|
+
Defined in: [gridstack.ts:1428](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1428)
|
|
1511
1499
|
|
|
1512
1500
|
Removes all widgets from the grid.
|
|
1513
1501
|
|
|
@@ -1552,7 +1540,7 @@ removeWidget(
|
|
|
1552
1540
|
triggerEvent): GridStack;
|
|
1553
1541
|
```
|
|
1554
1542
|
|
|
1555
|
-
Defined in: [gridstack.ts:
|
|
1543
|
+
Defined in: [gridstack.ts:1390](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1390)
|
|
1556
1544
|
|
|
1557
1545
|
Removes widget from the grid.
|
|
1558
1546
|
|
|
@@ -1574,7 +1562,7 @@ Removes widget from the grid.
|
|
|
1574
1562
|
resizable(els, val): GridStack;
|
|
1575
1563
|
```
|
|
1576
1564
|
|
|
1577
|
-
Defined in: [gridstack.ts:
|
|
1565
|
+
Defined in: [gridstack.ts:2253](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2253)
|
|
1578
1566
|
|
|
1579
1567
|
Enables/Disables user resizing for specific grid elements.
|
|
1580
1568
|
For all items and future items, use enableResize() instead. No-op for static grids.
|
|
@@ -1608,12 +1596,12 @@ grid.resizable('#fixed-size-widget', false);
|
|
|
1608
1596
|
resizeToContent(el): void;
|
|
1609
1597
|
```
|
|
1610
1598
|
|
|
1611
|
-
Defined in: [gridstack.ts:
|
|
1599
|
+
Defined in: [gridstack.ts:1652](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1652)
|
|
1612
1600
|
|
|
1613
1601
|
Updates widget height to match the content height to avoid vertical scrollbars or dead space.
|
|
1614
1602
|
This automatically adjusts the widget height based on its content size.
|
|
1615
1603
|
|
|
1616
|
-
Note: This assumes only 1 child under resizeToContentParent='.grid-stack-item-content'
|
|
1604
|
+
Note: This assumes only 1 child under resizeToContentParent='.grid-stack-item-content'
|
|
1617
1605
|
(sized to gridItem minus padding) that represents the entire content size.
|
|
1618
1606
|
|
|
1619
1607
|
###### Parameters
|
|
@@ -1644,7 +1632,7 @@ grid.resizeToContent(widget);
|
|
|
1644
1632
|
rotate(els, relative?): GridStack;
|
|
1645
1633
|
```
|
|
1646
1634
|
|
|
1647
|
-
Defined in: [gridstack.ts:
|
|
1635
|
+
Defined in: [gridstack.ts:1727](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1727)
|
|
1648
1636
|
|
|
1649
1637
|
Rotate widgets by swapping their width and height. This is typically called when the user presses 'r' during dragging.
|
|
1650
1638
|
The rotation swaps the w/h dimensions and adjusts min/max constraints accordingly.
|
|
@@ -1710,7 +1698,7 @@ list of widgets or full grid option, including .children list of widgets
|
|
|
1710
1698
|
setAnimation(doAnimate, delay?): GridStack;
|
|
1711
1699
|
```
|
|
1712
1700
|
|
|
1713
|
-
Defined in: [gridstack.ts:
|
|
1701
|
+
Defined in: [gridstack.ts:1447](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1447)
|
|
1714
1702
|
|
|
1715
1703
|
Toggle the grid animation state. Toggles the `grid-stack-animate` class.
|
|
1716
1704
|
|
|
@@ -1734,7 +1722,7 @@ setStatic(
|
|
|
1734
1722
|
recurse): GridStack;
|
|
1735
1723
|
```
|
|
1736
1724
|
|
|
1737
|
-
Defined in: [gridstack.ts:
|
|
1725
|
+
Defined in: [gridstack.ts:1470](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1470)
|
|
1738
1726
|
|
|
1739
1727
|
Toggle the grid static state, which permanently removes/add Drag&Drop support, unlike disable()/enable() that just turns it off/on.
|
|
1740
1728
|
Also toggle the grid-stack-static class.
|
|
@@ -1761,7 +1749,7 @@ static setupDragIn(
|
|
|
1761
1749
|
root?): void;
|
|
1762
1750
|
```
|
|
1763
1751
|
|
|
1764
|
-
Defined in: [gridstack.ts:
|
|
1752
|
+
Defined in: [gridstack.ts:2196](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2196)
|
|
1765
1753
|
|
|
1766
1754
|
call to setup dragging in from the outside (say toolbar), by specifying the class selection and options.
|
|
1767
1755
|
Called during GridStack.init() as options, but can also be called directly (last param are used) in case the toolbar
|
|
@@ -1774,7 +1762,7 @@ is dynamically create and needs to be set later.
|
|
|
1774
1762
|
| `dragIn?` | `string` \| `HTMLElement`[] | `undefined` | string selector (ex: '.sidebar-item') or list of dom elements |
|
|
1775
1763
|
| `dragInOptions?` | [`DDDragOpt`](#dddragopt) | `undefined` | options - see DDDragOpt. (default: {handle: '.grid-stack-item-content', appendTo: 'body'} |
|
|
1776
1764
|
| `widgets?` | [`GridStackWidget`](#gridstackwidget)[] | `undefined` | GridStackWidget def to assign to each element which defines what to create on drop |
|
|
1777
|
-
| `root?` | `
|
|
1765
|
+
| `root?` | `HTMLElement` \| `Document` | `document` | optional root which defaults to document (for shadow dom pass the parent HTMLDocument) |
|
|
1778
1766
|
|
|
1779
1767
|
###### Returns
|
|
1780
1768
|
|
|
@@ -1786,7 +1774,7 @@ is dynamically create and needs to be set later.
|
|
|
1786
1774
|
protected triggerEvent(event, target): void;
|
|
1787
1775
|
```
|
|
1788
1776
|
|
|
1789
|
-
Defined in: [gridstack.ts:
|
|
1777
|
+
Defined in: [gridstack.ts:2964](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L2964)
|
|
1790
1778
|
|
|
1791
1779
|
call given event callback on our main top-most grid (if we're nested)
|
|
1792
1780
|
|
|
@@ -1807,7 +1795,7 @@ call given event callback on our main top-most grid (if we're nested)
|
|
|
1807
1795
|
update(els, opt): GridStack;
|
|
1808
1796
|
```
|
|
1809
1797
|
|
|
1810
|
-
Defined in: [gridstack.ts:
|
|
1798
|
+
Defined in: [gridstack.ts:1548](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1548)
|
|
1811
1799
|
|
|
1812
1800
|
Updates widget position/size and other info. This is used to change widget properties after creation.
|
|
1813
1801
|
Can update position, size, content, and other widget properties.
|
|
@@ -1852,7 +1840,7 @@ grid.update('#my-widget', {
|
|
|
1852
1840
|
updateOptions(o): GridStack;
|
|
1853
1841
|
```
|
|
1854
1842
|
|
|
1855
|
-
Defined in: [gridstack.ts:
|
|
1843
|
+
Defined in: [gridstack.ts:1488](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1488)
|
|
1856
1844
|
|
|
1857
1845
|
Updates the passed in options on the grid (similar to update(widget) for for the grid options).
|
|
1858
1846
|
|
|
@@ -1872,7 +1860,7 @@ Updates the passed in options on the grid (similar to update(widget) for for the
|
|
|
1872
1860
|
willItFit(node): boolean;
|
|
1873
1861
|
```
|
|
1874
1862
|
|
|
1875
|
-
Defined in: [gridstack.ts:
|
|
1863
|
+
Defined in: [gridstack.ts:1805](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack.ts#L1805)
|
|
1876
1864
|
|
|
1877
1865
|
Returns true if the height of the grid will be less than the vertical
|
|
1878
1866
|
constraint. Always returns true if grid doesn't have height constraint.
|
|
@@ -2130,7 +2118,7 @@ cacheLayout(
|
|
|
2130
2118
|
clear): GridStackEngine;
|
|
2131
2119
|
```
|
|
2132
2120
|
|
|
2133
|
-
Defined in: [gridstack-engine.ts:
|
|
2121
|
+
Defined in: [gridstack-engine.ts:1199](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1199)
|
|
2134
2122
|
|
|
2135
2123
|
call to cache the given layout internally to the given location so we can restore back when column changes size
|
|
2136
2124
|
|
|
@@ -2152,7 +2140,7 @@ call to cache the given layout internally to the given location so we can restor
|
|
|
2152
2140
|
cacheOneLayout(n, column): GridStackEngine;
|
|
2153
2141
|
```
|
|
2154
2142
|
|
|
2155
|
-
Defined in: [gridstack-engine.ts:
|
|
2143
|
+
Defined in: [gridstack-engine.ts:1219](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1219)
|
|
2156
2144
|
|
|
2157
2145
|
call to cache the given node layout internally to the given location so we can restore back when column changes size
|
|
2158
2146
|
|
|
@@ -2194,7 +2182,7 @@ true if x,y or w,h are different after clamping to min/max
|
|
|
2194
2182
|
cleanupNode(node): GridStackEngine;
|
|
2195
2183
|
```
|
|
2196
2184
|
|
|
2197
|
-
Defined in: [gridstack-engine.ts:
|
|
2185
|
+
Defined in: [gridstack-engine.ts:1250](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1250)
|
|
2198
2186
|
|
|
2199
2187
|
called to remove all internal values but the _id
|
|
2200
2188
|
|
|
@@ -2357,7 +2345,7 @@ Defined in: [gridstack-engine.ts:1002](https://github.com/adumesny/gridstack.js/
|
|
|
2357
2345
|
protected findCacheLayout(n, column): number;
|
|
2358
2346
|
```
|
|
2359
2347
|
|
|
2360
|
-
Defined in: [gridstack-engine.ts:
|
|
2348
|
+
Defined in: [gridstack-engine.ts:1233](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1233)
|
|
2361
2349
|
|
|
2362
2350
|
###### Parameters
|
|
2363
2351
|
|
|
@@ -2680,7 +2668,7 @@ engine.removeNode(node, true, true);
|
|
|
2680
2668
|
removeNodeFromLayoutCache(n): void;
|
|
2681
2669
|
```
|
|
2682
2670
|
|
|
2683
|
-
Defined in: [gridstack-engine.ts:
|
|
2671
|
+
Defined in: [gridstack-engine.ts:1237](https://github.com/adumesny/gridstack.js/blob/master/src/gridstack-engine.ts#L1237)
|
|
2684
2672
|
|
|
2685
2673
|
###### Parameters
|
|
2686
2674
|
|
|
@@ -2845,7 +2833,7 @@ new Utils(): Utils;
|
|
|
2845
2833
|
static addElStyles(el, styles): void;
|
|
2846
2834
|
```
|
|
2847
2835
|
|
|
2848
|
-
Defined in: [utils.ts:
|
|
2836
|
+
Defined in: [utils.ts:701](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L701)
|
|
2849
2837
|
|
|
2850
2838
|
###### Parameters
|
|
2851
2839
|
|
|
@@ -2864,7 +2852,7 @@ Defined in: [utils.ts:690](https://github.com/adumesny/gridstack.js/blob/master/
|
|
|
2864
2852
|
static appendTo(el, parent): void;
|
|
2865
2853
|
```
|
|
2866
2854
|
|
|
2867
|
-
Defined in: [utils.ts:
|
|
2855
|
+
Defined in: [utils.ts:683](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L683)
|
|
2868
2856
|
|
|
2869
2857
|
###### Parameters
|
|
2870
2858
|
|
|
@@ -2883,7 +2871,7 @@ Defined in: [utils.ts:672](https://github.com/adumesny/gridstack.js/blob/master/
|
|
|
2883
2871
|
static area(a): number;
|
|
2884
2872
|
```
|
|
2885
2873
|
|
|
2886
|
-
Defined in: [utils.ts:
|
|
2874
|
+
Defined in: [utils.ts:297](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L297)
|
|
2887
2875
|
|
|
2888
2876
|
Calculate the total area of a grid position.
|
|
2889
2877
|
|
|
@@ -2911,7 +2899,7 @@ const area = Utils.area({x: 0, y: 0, w: 3, h: 2}); // returns 6
|
|
|
2911
2899
|
static areaIntercept(a, b): number;
|
|
2912
2900
|
```
|
|
2913
2901
|
|
|
2914
|
-
Defined in: [utils.ts:
|
|
2902
|
+
Defined in: [utils.ts:278](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L278)
|
|
2915
2903
|
|
|
2916
2904
|
Calculate the overlapping area between two grid positions.
|
|
2917
2905
|
|
|
@@ -2943,7 +2931,7 @@ const overlap = Utils.areaIntercept(
|
|
|
2943
2931
|
static canBeRotated(n): boolean;
|
|
2944
2932
|
```
|
|
2945
2933
|
|
|
2946
|
-
Defined in: [utils.ts:
|
|
2934
|
+
Defined in: [utils.ts:804](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L804)
|
|
2947
2935
|
|
|
2948
2936
|
true if the item can be rotated (checking for prop, not space available)
|
|
2949
2937
|
|
|
@@ -2963,7 +2951,7 @@ true if the item can be rotated (checking for prop, not space available)
|
|
|
2963
2951
|
static clone<T>(obj): T;
|
|
2964
2952
|
```
|
|
2965
2953
|
|
|
2966
|
-
Defined in: [utils.ts:
|
|
2954
|
+
Defined in: [utils.ts:646](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L646)
|
|
2967
2955
|
|
|
2968
2956
|
single level clone, returning a new object with same top fields. This will share sub objects and arrays
|
|
2969
2957
|
|
|
@@ -2989,7 +2977,7 @@ single level clone, returning a new object with same top fields. This will share
|
|
|
2989
2977
|
static cloneDeep<T>(obj): T;
|
|
2990
2978
|
```
|
|
2991
2979
|
|
|
2992
|
-
Defined in: [utils.ts:
|
|
2980
|
+
Defined in: [utils.ts:662](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L662)
|
|
2993
2981
|
|
|
2994
2982
|
Recursive clone version that returns a full copy, checking for nested objects and arrays ONLY.
|
|
2995
2983
|
Note: this will use as-is any key starting with double __ (and not copy inside) some lib have circular dependencies.
|
|
@@ -3016,7 +3004,7 @@ Note: this will use as-is any key starting with double __ (and not copy inside)
|
|
|
3016
3004
|
static cloneNode(el): HTMLElement;
|
|
3017
3005
|
```
|
|
3018
3006
|
|
|
3019
|
-
Defined in: [utils.ts:
|
|
3007
|
+
Defined in: [utils.ts:677](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L677)
|
|
3020
3008
|
|
|
3021
3009
|
deep clone the given HTML node, removing teh unique id field
|
|
3022
3010
|
|
|
@@ -3039,7 +3027,7 @@ static copyPos(
|
|
|
3039
3027
|
doMinMax): GridStackWidget;
|
|
3040
3028
|
```
|
|
3041
3029
|
|
|
3042
|
-
Defined in: [utils.ts:
|
|
3030
|
+
Defined in: [utils.ts:474](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L474)
|
|
3043
3031
|
|
|
3044
3032
|
Copy position and size properties from one widget to another.
|
|
3045
3033
|
Copies x, y, w, h and optionally min/max constraints.
|
|
@@ -3071,7 +3059,7 @@ Utils.copyPos(widget1, widget2, true); // Also copy constraints
|
|
|
3071
3059
|
static createDiv(classes, parent?): HTMLElement;
|
|
3072
3060
|
```
|
|
3073
3061
|
|
|
3074
|
-
Defined in: [utils.ts:
|
|
3062
|
+
Defined in: [utils.ts:206](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L206)
|
|
3075
3063
|
|
|
3076
3064
|
Create a div element with the specified CSS classes.
|
|
3077
3065
|
|
|
@@ -3101,7 +3089,7 @@ const nested = Utils.createDiv(['content'], parentDiv);
|
|
|
3101
3089
|
static defaults(target, ...sources): object;
|
|
3102
3090
|
```
|
|
3103
3091
|
|
|
3104
|
-
Defined in: [utils.ts:
|
|
3092
|
+
Defined in: [utils.ts:421](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L421)
|
|
3105
3093
|
|
|
3106
3094
|
Copy unset fields from source objects to target object (shallow merge with defaults).
|
|
3107
3095
|
Similar to Object.assign but only sets undefined/null fields.
|
|
@@ -3133,7 +3121,7 @@ Utils.defaults(config, { width: 200, height: 50 });
|
|
|
3133
3121
|
static find(nodes, id): GridStackNode;
|
|
3134
3122
|
```
|
|
3135
3123
|
|
|
3136
|
-
Defined in: [utils.ts:
|
|
3124
|
+
Defined in: [utils.ts:332](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L332)
|
|
3137
3125
|
|
|
3138
3126
|
Find a grid node by its ID.
|
|
3139
3127
|
|
|
@@ -3163,7 +3151,7 @@ if (node) console.log('Found node at:', node.x, node.y);
|
|
|
3163
3151
|
static getElement(els, root): HTMLElement;
|
|
3164
3152
|
```
|
|
3165
3153
|
|
|
3166
|
-
Defined in: [utils.ts:
|
|
3154
|
+
Defined in: [utils.ts:155](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L155)
|
|
3167
3155
|
|
|
3168
3156
|
Convert a potential selector into a single HTML element.
|
|
3169
3157
|
Similar to getElements() but returns only the first match.
|
|
@@ -3173,7 +3161,7 @@ Similar to getElements() but returns only the first match.
|
|
|
3173
3161
|
| Parameter | Type | Default value | Description |
|
|
3174
3162
|
| ------ | ------ | ------ | ------ |
|
|
3175
3163
|
| `els` | [`GridStackElement`](#gridstackelement) | `undefined` | selector string or HTMLElement |
|
|
3176
|
-
| `root` | `
|
|
3164
|
+
| `root` | `HTMLElement` \| `Document` | `document` | optional root element to search within (defaults to document) |
|
|
3177
3165
|
|
|
3178
3166
|
###### Returns
|
|
3179
3167
|
|
|
@@ -3204,7 +3192,7 @@ Supports CSS selectors, element references, and special ID handling.
|
|
|
3204
3192
|
| Parameter | Type | Default value | Description |
|
|
3205
3193
|
| ------ | ------ | ------ | ------ |
|
|
3206
3194
|
| `els` | [`GridStackElement`](#gridstackelement) | `undefined` | selector string, HTMLElement, or array of elements |
|
|
3207
|
-
| `root` | `
|
|
3195
|
+
| `root` | `HTMLElement` \| `Document` | `document` | optional root element to search within (defaults to document, useful for shadow DOM) |
|
|
3208
3196
|
|
|
3209
3197
|
###### Returns
|
|
3210
3198
|
|
|
@@ -3226,7 +3214,7 @@ const fromShadow = Utils.getElements('.item', shadowRoot);
|
|
|
3226
3214
|
static getValuesFromTransformedElement(parent): DragTransform;
|
|
3227
3215
|
```
|
|
3228
3216
|
|
|
3229
|
-
Defined in: [utils.ts:
|
|
3217
|
+
Defined in: [utils.ts:761](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L761)
|
|
3230
3218
|
|
|
3231
3219
|
defines an element that is used to get the offset and scale from grid transforms
|
|
3232
3220
|
returns the scale and offsets from said element
|
|
@@ -3247,7 +3235,7 @@ returns the scale and offsets from said element
|
|
|
3247
3235
|
static initEvent<T>(e, info): T;
|
|
3248
3236
|
```
|
|
3249
3237
|
|
|
3250
|
-
Defined in: [utils.ts:
|
|
3238
|
+
Defined in: [utils.ts:718](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L718)
|
|
3251
3239
|
|
|
3252
3240
|
###### Type Parameters
|
|
3253
3241
|
|
|
@@ -3274,7 +3262,7 @@ Defined in: [utils.ts:707](https://github.com/adumesny/gridstack.js/blob/master/
|
|
|
3274
3262
|
static isIntercepted(a, b): boolean;
|
|
3275
3263
|
```
|
|
3276
3264
|
|
|
3277
|
-
Defined in: [utils.ts:
|
|
3265
|
+
Defined in: [utils.ts:244](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L244)
|
|
3278
3266
|
|
|
3279
3267
|
Check if two grid positions overlap/intersect.
|
|
3280
3268
|
|
|
@@ -3306,7 +3294,7 @@ const overlaps = Utils.isIntercepted(
|
|
|
3306
3294
|
static isTouching(a, b): boolean;
|
|
3307
3295
|
```
|
|
3308
3296
|
|
|
3309
|
-
Defined in: [utils.ts:
|
|
3297
|
+
Defined in: [utils.ts:261](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L261)
|
|
3310
3298
|
|
|
3311
3299
|
Check if two grid positions are touching (edges or corners).
|
|
3312
3300
|
|
|
@@ -3338,7 +3326,7 @@ const touching = Utils.isTouching(
|
|
|
3338
3326
|
static lazyLoad(n): boolean;
|
|
3339
3327
|
```
|
|
3340
3328
|
|
|
3341
|
-
Defined in: [utils.ts:
|
|
3329
|
+
Defined in: [utils.ts:191](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L191)
|
|
3342
3330
|
|
|
3343
3331
|
Check if a widget should be lazy loaded based on node or grid settings.
|
|
3344
3332
|
|
|
@@ -3368,7 +3356,7 @@ if (Utils.lazyLoad(node)) {
|
|
|
3368
3356
|
static parseHeight(val): HeightData;
|
|
3369
3357
|
```
|
|
3370
3358
|
|
|
3371
|
-
Defined in: [utils.ts:
|
|
3359
|
+
Defined in: [utils.ts:388](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L388)
|
|
3372
3360
|
|
|
3373
3361
|
Parse a height value with units into numeric value and unit string.
|
|
3374
3362
|
Supports px, em, rem, vh, vw, %, cm, mm units.
|
|
@@ -3399,7 +3387,7 @@ Utils.parseHeight(50); // {h: 50, unit: 'px'}
|
|
|
3399
3387
|
static removeInternalAndSame(a, b): void;
|
|
3400
3388
|
```
|
|
3401
3389
|
|
|
3402
|
-
Defined in: [utils.ts:
|
|
3390
|
+
Defined in: [utils.ts:503](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L503)
|
|
3403
3391
|
|
|
3404
3392
|
removes field from the first object if same as the second objects (like diffing) and internal '_' for saving
|
|
3405
3393
|
|
|
@@ -3420,7 +3408,7 @@ removes field from the first object if same as the second objects (like diffing)
|
|
|
3420
3408
|
static removeInternalForSave(n, removeEl): void;
|
|
3421
3409
|
```
|
|
3422
3410
|
|
|
3423
|
-
Defined in: [utils.ts:
|
|
3411
|
+
Defined in: [utils.ts:520](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L520)
|
|
3424
3412
|
|
|
3425
3413
|
removes internal fields '_' and default values for saving
|
|
3426
3414
|
|
|
@@ -3441,7 +3429,7 @@ removes internal fields '_' and default values for saving
|
|
|
3441
3429
|
static removePositioningStyles(el): void;
|
|
3442
3430
|
```
|
|
3443
3431
|
|
|
3444
|
-
Defined in: [utils.ts:
|
|
3432
|
+
Defined in: [utils.ts:553](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L553)
|
|
3445
3433
|
|
|
3446
3434
|
###### Parameters
|
|
3447
3435
|
|
|
@@ -3459,7 +3447,7 @@ Defined in: [utils.ts:542](https://github.com/adumesny/gridstack.js/blob/master/
|
|
|
3459
3447
|
static same(a, b): boolean;
|
|
3460
3448
|
```
|
|
3461
3449
|
|
|
3462
|
-
Defined in: [utils.ts:
|
|
3450
|
+
Defined in: [utils.ts:450](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L450)
|
|
3463
3451
|
|
|
3464
3452
|
Compare two objects for equality (shallow comparison).
|
|
3465
3453
|
Checks if objects have the same fields and values at one level deep.
|
|
@@ -3490,7 +3478,7 @@ Utils.same({x: 1}, {x: 1, y: 2}); // false
|
|
|
3490
3478
|
static samePos(a, b): boolean;
|
|
3491
3479
|
```
|
|
3492
3480
|
|
|
3493
|
-
Defined in: [utils.ts:
|
|
3481
|
+
Defined in: [utils.ts:489](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L489)
|
|
3494
3482
|
|
|
3495
3483
|
true if a and b has same size & position
|
|
3496
3484
|
|
|
@@ -3511,7 +3499,7 @@ true if a and b has same size & position
|
|
|
3511
3499
|
static sanitizeMinMax(node): void;
|
|
3512
3500
|
```
|
|
3513
3501
|
|
|
3514
|
-
Defined in: [utils.ts:
|
|
3502
|
+
Defined in: [utils.ts:494](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L494)
|
|
3515
3503
|
|
|
3516
3504
|
given a node, makes sure it's min/max are valid
|
|
3517
3505
|
|
|
@@ -3531,7 +3519,7 @@ given a node, makes sure it's min/max are valid
|
|
|
3531
3519
|
static shouldSizeToContent(n, strict): boolean;
|
|
3532
3520
|
```
|
|
3533
3521
|
|
|
3534
|
-
Defined in: [utils.ts:
|
|
3522
|
+
Defined in: [utils.ts:225](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L225)
|
|
3535
3523
|
|
|
3536
3524
|
Check if a widget should resize to fit its content.
|
|
3537
3525
|
|
|
@@ -3565,7 +3553,7 @@ static simulateMouseEvent(
|
|
|
3565
3553
|
target?): void;
|
|
3566
3554
|
```
|
|
3567
3555
|
|
|
3568
|
-
Defined in: [utils.ts:
|
|
3556
|
+
Defined in: [utils.ts:734](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L734)
|
|
3569
3557
|
|
|
3570
3558
|
copies the MouseEvent (or convert Touch) properties and sends it as another event to the given target
|
|
3571
3559
|
|
|
@@ -3587,7 +3575,7 @@ copies the MouseEvent (or convert Touch) properties and sends it as another even
|
|
|
3587
3575
|
static sort(nodes, dir): GridStackNode[];
|
|
3588
3576
|
```
|
|
3589
3577
|
|
|
3590
|
-
Defined in: [utils.ts:
|
|
3578
|
+
Defined in: [utils.ts:312](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L312)
|
|
3591
3579
|
|
|
3592
3580
|
Sort an array of grid nodes by position (y first, then x).
|
|
3593
3581
|
|
|
@@ -3620,7 +3608,7 @@ static swap(
|
|
|
3620
3608
|
b): void;
|
|
3621
3609
|
```
|
|
3622
3610
|
|
|
3623
|
-
Defined in: [utils.ts:
|
|
3611
|
+
Defined in: [utils.ts:785](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L785)
|
|
3624
3612
|
|
|
3625
3613
|
swap the given object 2 field values
|
|
3626
3614
|
|
|
@@ -3642,7 +3630,7 @@ swap the given object 2 field values
|
|
|
3642
3630
|
static throttle(func, delay): () => void;
|
|
3643
3631
|
```
|
|
3644
3632
|
|
|
3645
|
-
Defined in: [utils.ts:
|
|
3633
|
+
Defined in: [utils.ts:543](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L543)
|
|
3646
3634
|
|
|
3647
3635
|
delay calling the given function for given delay, preventing new calls from happening while waiting
|
|
3648
3636
|
|
|
@@ -3669,7 +3657,7 @@ delay calling the given function for given delay, preventing new calls from happ
|
|
|
3669
3657
|
static toBool(v): boolean;
|
|
3670
3658
|
```
|
|
3671
3659
|
|
|
3672
|
-
Defined in: [utils.ts:
|
|
3660
|
+
Defined in: [utils.ts:350](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L350)
|
|
3673
3661
|
|
|
3674
3662
|
Convert various value types to boolean.
|
|
3675
3663
|
Handles strings like 'false', 'no', '0' as false.
|
|
@@ -3701,7 +3689,7 @@ Utils.toBool('1'); // true
|
|
|
3701
3689
|
static toNumber(value): number;
|
|
3702
3690
|
```
|
|
3703
3691
|
|
|
3704
|
-
Defined in: [utils.ts:
|
|
3692
|
+
Defined in: [utils.ts:372](https://github.com/adumesny/gridstack.js/blob/master/src/utils.ts#L372)
|
|
3705
3693
|
|
|
3706
3694
|
Convert a string value to a number, handling null and empty strings.
|
|
3707
3695
|
|
|
@@ -3767,12 +3755,12 @@ Defines the options for a Grid
|
|
|
3767
3755
|
| <a id="marginunit"></a> `marginUnit?` | `string` | (internal) unit for margin (default? 'px') set when `margin` is set as string with unit (ex: 2rem') | [types.ts:320](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L320) |
|
|
3768
3756
|
| <a id="maxrow-2"></a> `maxRow?` | `number` | maximum rows amount. Default? is 0 which means no maximum rows | [types.ts:323](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L323) |
|
|
3769
3757
|
| <a id="minrow"></a> `minRow?` | `number` | minimum rows amount which is handy to prevent grid from collapsing when empty. Default is `0`. When no set the `min-height` CSS attribute on the grid div (in pixels) can be used, which will round to the closest row. | [types.ts:328](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L328) |
|
|
3770
|
-
| <a id="nonce"></a> `nonce?` | `string` | If you are using a nonce-based Content Security Policy, pass your nonce here and GridStack will add it to the
|
|
3758
|
+
| <a id="nonce"></a> `nonce?` | `string` | If you are using a nonce-based Content Security Policy, pass your nonce here and GridStack will add it to the `<style>` elements it creates. | [types.ts:332](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L332) |
|
|
3771
3759
|
| <a id="placeholderclass"></a> `placeholderClass?` | `string` | class for placeholder (default?: 'grid-stack-placeholder') | [types.ts:335](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L335) |
|
|
3772
3760
|
| <a id="placeholdertext"></a> `placeholderText?` | `string` | placeholder default content (default?: '') | [types.ts:338](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L338) |
|
|
3773
3761
|
| <a id="removable"></a> `removable?` | `string` \| `boolean` | if true widgets could be removed by dragging outside of the grid. It could also be a selector string (ex: ".trash"), in this case widgets will be removed by dropping them there (default?: false) See example (http://gridstack.github.io/gridstack.js/demo/two.html) | [types.ts:348](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L348) |
|
|
3774
3762
|
| <a id="removableoptions"></a> `removableOptions?` | [`DDRemoveOpt`](#ddremoveopt) | allows to override UI removable options. (default?: { accept: '.grid-stack-item' }) | [types.ts:351](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L351) |
|
|
3775
|
-
| <a id="resizable-4"></a> `resizable?` | [`DDResizeOpt`](#ddresizeopt) | allows to override UI resizable options.
|
|
3763
|
+
| <a id="resizable-4"></a> `resizable?` | [`DDResizeOpt`](#ddresizeopt) | allows to override UI resizable options. default is { handles: 'se', autoHide: true on desktop, false on mobile } | [types.ts:341](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L341) |
|
|
3776
3764
|
| <a id="row"></a> `row?` | `number` | fix grid number of rows. This is a shortcut of writing `minRow:N, maxRow:N`. (default `0` no constrain) | [types.ts:354](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L354) |
|
|
3777
3765
|
| <a id="rtl"></a> `rtl?` | `boolean` \| `"auto"` | if true turns grid to RTL. Possible values are true, false, 'auto' (default?: 'auto') See [example](http://gridstack.github.io/gridstack.js/demo/right-to-left(rtl).html) | [types.ts:360](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L360) |
|
|
3778
3766
|
| <a id="sizetocontent-1"></a> `sizeToContent?` | `boolean` | set to true if all grid items (by default, but item can also override) height should be based on content size instead of WidgetItem.h to avoid v-scrollbars. Note: this is still row based, not pixels, so it will use ceil(getBoundingClientRect().height / getCellHeight()) | [types.ts:365](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L365) |
|
|
@@ -4297,7 +4285,7 @@ Subclasses should override to perform additional cleanup.
|
|
|
4297
4285
|
drop(e): void;
|
|
4298
4286
|
```
|
|
4299
4287
|
|
|
4300
|
-
Defined in: [dd-droppable.ts:
|
|
4288
|
+
Defined in: [dd-droppable.ts:145](https://github.com/adumesny/gridstack.js/blob/master/src/dd-droppable.ts#L145)
|
|
4301
4289
|
|
|
4302
4290
|
item is being dropped on us - called by the drag mouseup handler - this calls the client drop event
|
|
4303
4291
|
|
|
@@ -4906,7 +4894,7 @@ new DDManager(): DDManager;
|
|
|
4906
4894
|
<a id="ddresizable-1"></a>
|
|
4907
4895
|
### DDResizable
|
|
4908
4896
|
|
|
4909
|
-
Defined in: [dd-resizable.ts:
|
|
4897
|
+
Defined in: [dd-resizable.ts:32](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L32)
|
|
4910
4898
|
|
|
4911
4899
|
Interface for HTML elements extended with drag & drop options.
|
|
4912
4900
|
Used to associate DD configuration with DOM elements.
|
|
@@ -4950,7 +4938,7 @@ Note: Use enable()/disable() methods to change state as other operations need to
|
|
|
4950
4938
|
new DDResizable(el, option): DDResizable;
|
|
4951
4939
|
```
|
|
4952
4940
|
|
|
4953
|
-
Defined in: [dd-resizable.ts:
|
|
4941
|
+
Defined in: [dd-resizable.ts:59](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L59)
|
|
4954
4942
|
|
|
4955
4943
|
###### Parameters
|
|
4956
4944
|
|
|
@@ -4975,7 +4963,7 @@ Defined in: [dd-resizable.ts:61](https://github.com/adumesny/gridstack.js/blob/m
|
|
|
4975
4963
|
destroy(): void;
|
|
4976
4964
|
```
|
|
4977
4965
|
|
|
4978
|
-
Defined in: [dd-resizable.ts:
|
|
4966
|
+
Defined in: [dd-resizable.ts:89](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L89)
|
|
4979
4967
|
|
|
4980
4968
|
Destroy this drag & drop implementation and clean up resources.
|
|
4981
4969
|
Removes all event handlers and clears internal state.
|
|
@@ -4994,7 +4982,7 @@ Removes all event handlers and clears internal state.
|
|
|
4994
4982
|
disable(): void;
|
|
4995
4983
|
```
|
|
4996
4984
|
|
|
4997
|
-
Defined in: [dd-resizable.ts:
|
|
4985
|
+
Defined in: [dd-resizable.ts:83](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L83)
|
|
4998
4986
|
|
|
4999
4987
|
Disable this drag & drop implementation.
|
|
5000
4988
|
Subclasses should override to perform additional cleanup.
|
|
@@ -5013,7 +5001,7 @@ Subclasses should override to perform additional cleanup.
|
|
|
5013
5001
|
enable(): void;
|
|
5014
5002
|
```
|
|
5015
5003
|
|
|
5016
|
-
Defined in: [dd-resizable.ts:
|
|
5004
|
+
Defined in: [dd-resizable.ts:77](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L77)
|
|
5017
5005
|
|
|
5018
5006
|
Enable this drag & drop implementation.
|
|
5019
5007
|
Subclasses should override to perform additional setup.
|
|
@@ -5032,7 +5020,7 @@ Subclasses should override to perform additional setup.
|
|
|
5032
5020
|
off(event): void;
|
|
5033
5021
|
```
|
|
5034
5022
|
|
|
5035
|
-
Defined in: [dd-resizable.ts:
|
|
5023
|
+
Defined in: [dd-resizable.ts:73](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L73)
|
|
5036
5024
|
|
|
5037
5025
|
Unregister an event callback for the specified event.
|
|
5038
5026
|
|
|
@@ -5056,7 +5044,7 @@ Unregister an event callback for the specified event.
|
|
|
5056
5044
|
on(event, callback): void;
|
|
5057
5045
|
```
|
|
5058
5046
|
|
|
5059
|
-
Defined in: [dd-resizable.ts:
|
|
5047
|
+
Defined in: [dd-resizable.ts:69](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L69)
|
|
5060
5048
|
|
|
5061
5049
|
Register an event callback for the specified event.
|
|
5062
5050
|
|
|
@@ -5108,7 +5096,7 @@ Result from the callback function, if any
|
|
|
5108
5096
|
updateOption(opts): DDResizable;
|
|
5109
5097
|
```
|
|
5110
5098
|
|
|
5111
|
-
Defined in: [dd-resizable.ts:
|
|
5099
|
+
Defined in: [dd-resizable.ts:96](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L96)
|
|
5112
5100
|
|
|
5113
5101
|
Method to update the options and return the DD implementation
|
|
5114
5102
|
|
|
@@ -5130,15 +5118,15 @@ Method to update the options and return the DD implementation
|
|
|
5130
5118
|
|
|
5131
5119
|
| Property | Modifier | Type | Default value | Description | Defined in |
|
|
5132
5120
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
5133
|
-
| <a id="el-3"></a> `el` | `public` | [`GridItemHTMLElement`](#griditemhtmlelement) | `undefined` | The HTML element being extended | [dd-resizable.ts:
|
|
5134
|
-
| <a id="option-2"></a> `option` | `public` | [`DDResizableOpt`](#ddresizableopt) | `{}` | The drag & drop options/configuration | [dd-resizable.ts:
|
|
5121
|
+
| <a id="el-3"></a> `el` | `public` | [`GridItemHTMLElement`](#griditemhtmlelement) | `undefined` | The HTML element being extended | [dd-resizable.ts:59](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L59) |
|
|
5122
|
+
| <a id="option-2"></a> `option` | `public` | [`DDResizableOpt`](#ddresizableopt) | `{}` | The drag & drop options/configuration | [dd-resizable.ts:59](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L59) |
|
|
5135
5123
|
|
|
5136
5124
|
***
|
|
5137
5125
|
|
|
5138
5126
|
<a id="ddresizablehandle"></a>
|
|
5139
5127
|
### DDResizableHandle
|
|
5140
5128
|
|
|
5141
|
-
Defined in: [dd-resizable-handle.ts:
|
|
5129
|
+
Defined in: [dd-resizable-handle.ts:16](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L16)
|
|
5142
5130
|
|
|
5143
5131
|
#### Constructors
|
|
5144
5132
|
|
|
@@ -5151,7 +5139,7 @@ new DDResizableHandle(
|
|
|
5151
5139
|
option): DDResizableHandle;
|
|
5152
5140
|
```
|
|
5153
5141
|
|
|
5154
|
-
Defined in: [dd-resizable-handle.ts:
|
|
5142
|
+
Defined in: [dd-resizable-handle.ts:26](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L26)
|
|
5155
5143
|
|
|
5156
5144
|
###### Parameters
|
|
5157
5145
|
|
|
@@ -5173,7 +5161,7 @@ Defined in: [dd-resizable-handle.ts:25](https://github.com/adumesny/gridstack.js
|
|
|
5173
5161
|
destroy(): DDResizableHandle;
|
|
5174
5162
|
```
|
|
5175
5163
|
|
|
5176
|
-
Defined in: [dd-resizable-handle.ts:
|
|
5164
|
+
Defined in: [dd-resizable-handle.ts:70](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L70)
|
|
5177
5165
|
|
|
5178
5166
|
call this when resize handle needs to be removed and cleaned up
|
|
5179
5167
|
|
|
@@ -5185,9 +5173,9 @@ call this when resize handle needs to be removed and cleaned up
|
|
|
5185
5173
|
|
|
5186
5174
|
| Property | Modifier | Type | Defined in |
|
|
5187
5175
|
| ------ | ------ | ------ | ------ |
|
|
5188
|
-
| <a id="dir"></a> `dir` | `protected` | `string` | [dd-resizable-handle.ts:
|
|
5189
|
-
| <a id="host"></a> `host` | `protected` | [`GridItemHTMLElement`](#griditemhtmlelement) | [dd-resizable-handle.ts:
|
|
5190
|
-
| <a id="option-3"></a> `option` | `protected` | [`DDResizableHandleOpt`](#ddresizablehandleopt) | [dd-resizable-handle.ts:
|
|
5176
|
+
| <a id="dir"></a> `dir` | `protected` | `string` | [dd-resizable-handle.ts:26](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L26) |
|
|
5177
|
+
| <a id="host"></a> `host` | `protected` | [`GridItemHTMLElement`](#griditemhtmlelement) | [dd-resizable-handle.ts:26](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L26) |
|
|
5178
|
+
| <a id="option-3"></a> `option` | `protected` | [`DDResizableHandleOpt`](#ddresizablehandleopt) | [dd-resizable-handle.ts:26](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L26) |
|
|
5191
5179
|
|
|
5192
5180
|
***
|
|
5193
5181
|
|
|
@@ -5228,7 +5216,7 @@ Defines the position of a cell inside the grid
|
|
|
5228
5216
|
<a id="dddragopt"></a>
|
|
5229
5217
|
### DDDragOpt
|
|
5230
5218
|
|
|
5231
|
-
Defined in: [types.ts:
|
|
5219
|
+
Defined in: [types.ts:483](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L483)
|
|
5232
5220
|
|
|
5233
5221
|
Drag&Drop dragging options
|
|
5234
5222
|
|
|
@@ -5236,15 +5224,15 @@ Drag&Drop dragging options
|
|
|
5236
5224
|
|
|
5237
5225
|
| Property | Type | Description | Defined in |
|
|
5238
5226
|
| ------ | ------ | ------ | ------ |
|
|
5239
|
-
| <a id="appendto"></a> `appendTo?` | `string` | default to 'body' | [types.ts:
|
|
5240
|
-
| <a id="cancel"></a> `cancel?` | `string` | prevents dragging from starting on specified elements, listed as comma separated selectors (eg: '.no-drag'). default built in is 'input,textarea,button,select,option' | [types.ts:
|
|
5241
|
-
| <a id="drag"></a> `drag?` | (`event`, `ui`) => `void` | - | [types.ts:
|
|
5242
|
-
| <a id="handle"></a> `handle?` | `string` | class selector of items that can be dragged. default to '.grid-stack-item-content' | [types.ts:
|
|
5243
|
-
| <a id="helper-1"></a> `helper?` | `"clone"` \| (`el`) => `HTMLElement` | helper function when dropping: 'clone' or your own method | [types.ts:
|
|
5244
|
-
| <a id="pause"></a> `pause?` | `number` \| `boolean` | if set (true | msec), dragging placement (collision) will only happen after a pause by the user. Note: this is Global | [types.ts:
|
|
5245
|
-
| <a id="scroll"></a> `scroll?` | `boolean` | default to `true` | [types.ts:
|
|
5246
|
-
| <a id="start"></a> `start?` | (`event`, `ui`) => `void` | callbacks | [types.ts:
|
|
5247
|
-
| <a id="stop"></a> `stop?` | (`event`) => `void` | - | [types.ts:
|
|
5227
|
+
| <a id="appendto"></a> `appendTo?` | `string` | default to 'body' | [types.ts:487](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L487) |
|
|
5228
|
+
| <a id="cancel"></a> `cancel?` | `string` | prevents dragging from starting on specified elements, listed as comma separated selectors (eg: '.no-drag'). default built in is 'input,textarea,button,select,option' | [types.ts:493](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L493) |
|
|
5229
|
+
| <a id="drag"></a> `drag?` | (`event`, `ui`) => `void` | - | [types.ts:499](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L499) |
|
|
5230
|
+
| <a id="handle"></a> `handle?` | `string` | class selector of items that can be dragged. default to '.grid-stack-item-content' | [types.ts:485](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L485) |
|
|
5231
|
+
| <a id="helper-1"></a> `helper?` | `"clone"` \| (`el`) => `HTMLElement` | helper function when dropping: 'clone' or your own method | [types.ts:495](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L495) |
|
|
5232
|
+
| <a id="pause"></a> `pause?` | `number` \| `boolean` | if set (true | msec), dragging placement (collision) will only happen after a pause by the user. Note: this is Global | [types.ts:489](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L489) |
|
|
5233
|
+
| <a id="scroll"></a> `scroll?` | `boolean` | default to `true` | [types.ts:491](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L491) |
|
|
5234
|
+
| <a id="start"></a> `start?` | (`event`, `ui`) => `void` | callbacks | [types.ts:497](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L497) |
|
|
5235
|
+
| <a id="stop"></a> `stop?` | (`event`) => `void` | - | [types.ts:498](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L498) |
|
|
5248
5236
|
|
|
5249
5237
|
***
|
|
5250
5238
|
|
|
@@ -5288,7 +5276,7 @@ All grid item DOM elements implement this interface to provide access to their g
|
|
|
5288
5276
|
<a id="ddremoveopt"></a>
|
|
5289
5277
|
### DDRemoveOpt
|
|
5290
5278
|
|
|
5291
|
-
Defined in: [types.ts:
|
|
5279
|
+
Defined in: [types.ts:475](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L475)
|
|
5292
5280
|
|
|
5293
5281
|
Drag&Drop remove options
|
|
5294
5282
|
|
|
@@ -5296,8 +5284,8 @@ Drag&Drop remove options
|
|
|
5296
5284
|
|
|
5297
5285
|
| Property | Type | Description | Defined in |
|
|
5298
5286
|
| ------ | ------ | ------ | ------ |
|
|
5299
|
-
| <a id="accept-3"></a> `accept?` | `string` | class that can be removed (default?: opts.itemClass) | [types.ts:
|
|
5300
|
-
| <a id="decline"></a> `decline?` | `string` | class that cannot be removed (default: 'grid-stack-non-removable') | [types.ts:
|
|
5287
|
+
| <a id="accept-3"></a> `accept?` | `string` | class that can be removed (default?: opts.itemClass) | [types.ts:477](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L477) |
|
|
5288
|
+
| <a id="decline"></a> `decline?` | `string` | class that cannot be removed (default: 'grid-stack-non-removable') | [types.ts:479](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L479) |
|
|
5301
5289
|
|
|
5302
5290
|
***
|
|
5303
5291
|
|
|
@@ -5310,9 +5298,10 @@ Defined in: [dd-resizable-handle.ts:9](https://github.com/adumesny/gridstack.js/
|
|
|
5310
5298
|
|
|
5311
5299
|
| Property | Type | Defined in |
|
|
5312
5300
|
| ------ | ------ | ------ |
|
|
5313
|
-
| <a id="
|
|
5314
|
-
| <a id="
|
|
5315
|
-
| <a id="
|
|
5301
|
+
| <a id="element"></a> `element?` | `string` \| `HTMLElement` | [dd-resizable-handle.ts:10](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L10) |
|
|
5302
|
+
| <a id="move"></a> `move?` | (`event`) => `void` | [dd-resizable-handle.ts:12](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L12) |
|
|
5303
|
+
| <a id="start-1"></a> `start?` | (`event`) => `void` | [dd-resizable-handle.ts:11](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L11) |
|
|
5304
|
+
| <a id="stop-1"></a> `stop?` | (`event`) => `void` | [dd-resizable-handle.ts:13](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable-handle.ts#L13) |
|
|
5316
5305
|
|
|
5317
5306
|
***
|
|
5318
5307
|
|
|
@@ -5321,21 +5310,28 @@ Defined in: [dd-resizable-handle.ts:9](https://github.com/adumesny/gridstack.js/
|
|
|
5321
5310
|
|
|
5322
5311
|
Defined in: [dd-resizable.ts:15](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L15)
|
|
5323
5312
|
|
|
5313
|
+
Drag&Drop resize options
|
|
5314
|
+
|
|
5315
|
+
#### Extends
|
|
5316
|
+
|
|
5317
|
+
- [`DDResizeOpt`](#ddresizeopt)
|
|
5318
|
+
|
|
5324
5319
|
#### Properties
|
|
5325
5320
|
|
|
5326
|
-
| Property | Type | Defined in |
|
|
5327
|
-
| ------ | ------ | ------ |
|
|
5328
|
-
| <a id="autohide"></a> `autoHide?` | `boolean` | [
|
|
5329
|
-
| <a id="
|
|
5330
|
-
| <a id="
|
|
5331
|
-
| <a id="
|
|
5332
|
-
| <a id="
|
|
5333
|
-
| <a id="
|
|
5334
|
-
| <a id="
|
|
5335
|
-
| <a id="
|
|
5336
|
-
| <a id="
|
|
5337
|
-
| <a id="
|
|
5338
|
-
| <a id="
|
|
5321
|
+
| Property | Type | Description | Inherited from | Defined in |
|
|
5322
|
+
| ------ | ------ | ------ | ------ | ------ |
|
|
5323
|
+
| <a id="autohide"></a> `autoHide?` | `boolean` | do resize handle hide by default until mouse over. default: true on desktop, false on mobile | [`DDResizeOpt`](#ddresizeopt).[`autoHide`](#autohide-1) | [types.ts:461](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L461) |
|
|
5324
|
+
| <a id="element-1"></a> `element?` | `string` \| `HTMLElement` | Custom element or query inside the widget node that is used instead of the generated resize handle. | [`DDResizeOpt`](#ddresizeopt).[`element`](#element-2) | [types.ts:471](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L471) |
|
|
5325
|
+
| <a id="handles"></a> `handles?` | `string` | sides where you can resize from (ex: 'e, se, s, sw, w') - default 'se' (south-east) Note: it is not recommended to resize from the top sides as weird side effect may occur. | [`DDResizeOpt`](#ddresizeopt).[`handles`](#handles-1) | [types.ts:466](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L466) |
|
|
5326
|
+
| <a id="maxheight"></a> `maxHeight?` | `number` | - | - | [dd-resizable.ts:16](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L16) |
|
|
5327
|
+
| <a id="maxheightmoveup"></a> `maxHeightMoveUp?` | `number` | - | - | [dd-resizable.ts:17](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L17) |
|
|
5328
|
+
| <a id="maxwidth"></a> `maxWidth?` | `number` | - | - | [dd-resizable.ts:18](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L18) |
|
|
5329
|
+
| <a id="maxwidthmoveleft"></a> `maxWidthMoveLeft?` | `number` | - | - | [dd-resizable.ts:19](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L19) |
|
|
5330
|
+
| <a id="minheight"></a> `minHeight?` | `number` | - | - | [dd-resizable.ts:20](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L20) |
|
|
5331
|
+
| <a id="minwidth"></a> `minWidth?` | `number` | - | - | [dd-resizable.ts:21](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L21) |
|
|
5332
|
+
| <a id="resize"></a> `resize?` | (`event`, `ui`) => `void` | - | - | [dd-resizable.ts:24](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L24) |
|
|
5333
|
+
| <a id="start-2"></a> `start?` | (`event`, `ui`) => `void` | - | - | [dd-resizable.ts:22](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L22) |
|
|
5334
|
+
| <a id="stop-2"></a> `stop?` | (`event`) => `void` | - | - | [dd-resizable.ts:23](https://github.com/adumesny/gridstack.js/blob/master/src/dd-resizable.ts#L23) |
|
|
5339
5335
|
|
|
5340
5336
|
***
|
|
5341
5337
|
|
|
@@ -5346,11 +5342,16 @@ Defined in: [types.ts:459](https://github.com/adumesny/gridstack.js/blob/master/
|
|
|
5346
5342
|
|
|
5347
5343
|
Drag&Drop resize options
|
|
5348
5344
|
|
|
5345
|
+
#### Extended by
|
|
5346
|
+
|
|
5347
|
+
- [`DDResizableOpt`](#ddresizableopt)
|
|
5348
|
+
|
|
5349
5349
|
#### Properties
|
|
5350
5350
|
|
|
5351
5351
|
| Property | Type | Description | Defined in |
|
|
5352
5352
|
| ------ | ------ | ------ | ------ |
|
|
5353
|
-
| <a id="autohide-1"></a> `autoHide?` | `boolean` | do resize handle hide by default until mouse over
|
|
5353
|
+
| <a id="autohide-1"></a> `autoHide?` | `boolean` | do resize handle hide by default until mouse over. default: true on desktop, false on mobile | [types.ts:461](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L461) |
|
|
5354
|
+
| <a id="element-2"></a> `element?` | `string` \| `HTMLElement` | Custom element or query inside the widget node that is used instead of the generated resize handle. | [types.ts:471](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L471) |
|
|
5354
5355
|
| <a id="handles-1"></a> `handles?` | `string` | sides where you can resize from (ex: 'e, se, s, sw, w') - default 'se' (south-east) Note: it is not recommended to resize from the top sides as weird side effect may occur. | [types.ts:466](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L466) |
|
|
5355
5356
|
|
|
5356
5357
|
***
|
|
@@ -5358,7 +5359,7 @@ Drag&Drop resize options
|
|
|
5358
5359
|
<a id="dduidata"></a>
|
|
5359
5360
|
### DDUIData
|
|
5360
5361
|
|
|
5361
|
-
Defined in: [types.ts:
|
|
5362
|
+
Defined in: [types.ts:512](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L512)
|
|
5362
5363
|
|
|
5363
5364
|
data that is passed during drag and resizing callbacks
|
|
5364
5365
|
|
|
@@ -5366,9 +5367,9 @@ data that is passed during drag and resizing callbacks
|
|
|
5366
5367
|
|
|
5367
5368
|
| Property | Type | Defined in |
|
|
5368
5369
|
| ------ | ------ | ------ |
|
|
5369
|
-
| <a id="draggable-2"></a> `draggable?` | `HTMLElement` | [types.ts:
|
|
5370
|
-
| <a id="position"></a> `position?` | [`Position`](#position-1) | [types.ts:
|
|
5371
|
-
| <a id="size"></a> `size?` | [`Size`](#size-1) | [types.ts:
|
|
5370
|
+
| <a id="draggable-2"></a> `draggable?` | `HTMLElement` | [types.ts:515](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L515) |
|
|
5371
|
+
| <a id="position"></a> `position?` | [`Position`](#position-1) | [types.ts:513](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L513) |
|
|
5372
|
+
| <a id="size"></a> `size?` | [`Size`](#size-1) | [types.ts:514](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L514) |
|
|
5372
5373
|
|
|
5373
5374
|
***
|
|
5374
5375
|
|
|
@@ -5486,7 +5487,7 @@ options used during GridStackEngine.moveNode()
|
|
|
5486
5487
|
<a id="gridstacknode-2"></a>
|
|
5487
5488
|
### GridStackNode
|
|
5488
5489
|
|
|
5489
|
-
Defined in: [types.ts:
|
|
5490
|
+
Defined in: [types.ts:529](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L529)
|
|
5490
5491
|
|
|
5491
5492
|
internal runtime descriptions describing the widgets in the grid
|
|
5492
5493
|
|
|
@@ -5500,8 +5501,8 @@ internal runtime descriptions describing the widgets in the grid
|
|
|
5500
5501
|
| ------ | ------ | ------ | ------ | ------ |
|
|
5501
5502
|
| <a id="autoposition"></a> `autoPosition?` | `boolean` | if true then x, y parameters will be ignored and widget will be places on the first available position (default?: false) | [`GridStackWidget`](#gridstackwidget).[`autoPosition`](#autoposition-1) | [types.ts:428](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L428) |
|
|
5502
5503
|
| <a id="content"></a> `content?` | `string` | html to append inside as content | [`GridStackWidget`](#gridstackwidget).[`content`](#content-1) | [types.ts:446](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L446) |
|
|
5503
|
-
| <a id="el-5"></a> `el?` | [`GridItemHTMLElement`](#griditemhtmlelement) | pointer back to HTML element | - | [types.ts:
|
|
5504
|
-
| <a id="grid"></a> `grid?` | [`GridStack`](#gridstack-1) | pointer back to parent Grid instance | - | [types.ts:
|
|
5504
|
+
| <a id="el-5"></a> `el?` | [`GridItemHTMLElement`](#griditemhtmlelement) | pointer back to HTML element | - | [types.ts:531](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L531) |
|
|
5505
|
+
| <a id="grid"></a> `grid?` | [`GridStack`](#gridstack-1) | pointer back to parent Grid instance | - | [types.ts:533](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L533) |
|
|
5505
5506
|
| <a id="h-1"></a> `h?` | `number` | widget dimension height (default?: 1) | [`GridStackWidget`](#gridstackwidget).[`h`](#h-3) | [types.ts:420](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L420) |
|
|
5506
5507
|
| <a id="id"></a> `id?` | `string` | value for `gs-id` stored on the widget (default?: undefined) | [`GridStackWidget`](#gridstackwidget).[`id`](#id-1) | [types.ts:444](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L444) |
|
|
5507
5508
|
| <a id="lazyload"></a> `lazyLoad?` | `boolean` | true when widgets are only created when they scroll into view (visible) | [`GridStackWidget`](#gridstackwidget).[`lazyLoad`](#lazyload-2) | [types.ts:448](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L448) |
|
|
@@ -5514,9 +5515,9 @@ internal runtime descriptions describing the widgets in the grid
|
|
|
5514
5515
|
| <a id="noresize"></a> `noResize?` | `boolean` | prevent direct resizing by the user (default?: undefined = un-constrained) | [`GridStackWidget`](#gridstackwidget).[`noResize`](#noresize-1) | [types.ts:438](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L438) |
|
|
5515
5516
|
| <a id="resizetocontentparent-1"></a> `resizeToContentParent?` | `string` | local override of GridStack.resizeToContentParent that specify the class to use for the parent (actual) vs child (wanted) height | [`GridStackWidget`](#gridstackwidget).[`resizeToContentParent`](#resizetocontentparent-2) | [types.ts:453](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L453) |
|
|
5516
5517
|
| <a id="sizetocontent"></a> `sizeToContent?` | `number` \| `boolean` | local (vs grid) override - see GridStackOptions. Note: This also allow you to set a maximum h value (but user changeable during normal resizing) to prevent unlimited content from taking too much space (get scrollbar) | [`GridStackWidget`](#gridstackwidget).[`sizeToContent`](#sizetocontent-2) | [types.ts:451](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L451) |
|
|
5517
|
-
| <a id="subgrid"></a> `subGrid?` | [`GridStack`](#gridstack-1) | actual sub-grid instance | - | [types.ts:
|
|
5518
|
+
| <a id="subgrid"></a> `subGrid?` | [`GridStack`](#gridstack-1) | actual sub-grid instance | - | [types.ts:535](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L535) |
|
|
5518
5519
|
| <a id="subgridopts"></a> `subGridOpts?` | [`GridStackOptions`](#gridstackoptions) | optional nested grid options and list of children, which then turns into actual instance at runtime to get options from | [`GridStackWidget`](#gridstackwidget).[`subGridOpts`](#subgridopts-2) | [types.ts:455](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L455) |
|
|
5519
|
-
| <a id="visibleobservable"></a> `visibleObservable?` | `IntersectionObserver` | allow delay creation when visible | - | [types.ts:
|
|
5520
|
+
| <a id="visibleobservable"></a> `visibleObservable?` | `IntersectionObserver` | allow delay creation when visible | - | [types.ts:537](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L537) |
|
|
5520
5521
|
| <a id="w-2"></a> `w?` | `number` | widget dimension width (default?: 1) | [`GridStackWidget`](#gridstackwidget).[`w`](#w-4) | [types.ts:418](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L418) |
|
|
5521
5522
|
| <a id="x-2"></a> `x?` | `number` | widget position x (default?: 0) | [`GridStackWidget`](#gridstackwidget).[`x`](#x-4) | [types.ts:414](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L414) |
|
|
5522
5523
|
| <a id="y-2"></a> `y?` | `number` | widget position y (default?: 0) | [`GridStackWidget`](#gridstackwidget).[`y`](#y-4) | [types.ts:416](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L416) |
|
|
@@ -5662,7 +5663,7 @@ Defines the coordinates of an object
|
|
|
5662
5663
|
<a id="position-1"></a>
|
|
5663
5664
|
### Position
|
|
5664
5665
|
|
|
5665
|
-
Defined in: [types.ts:
|
|
5666
|
+
Defined in: [types.ts:505](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L505)
|
|
5666
5667
|
|
|
5667
5668
|
#### Extended by
|
|
5668
5669
|
|
|
@@ -5672,15 +5673,15 @@ Defined in: [types.ts:500](https://github.com/adumesny/gridstack.js/blob/master/
|
|
|
5672
5673
|
|
|
5673
5674
|
| Property | Type | Defined in |
|
|
5674
5675
|
| ------ | ------ | ------ |
|
|
5675
|
-
| <a id="left-1"></a> `left` | `number` | [types.ts:
|
|
5676
|
-
| <a id="top-1"></a> `top` | `number` | [types.ts:
|
|
5676
|
+
| <a id="left-1"></a> `left` | `number` | [types.ts:507](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L507) |
|
|
5677
|
+
| <a id="top-1"></a> `top` | `number` | [types.ts:506](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L506) |
|
|
5677
5678
|
|
|
5678
5679
|
***
|
|
5679
5680
|
|
|
5680
5681
|
<a id="rect-1"></a>
|
|
5681
5682
|
### Rect
|
|
5682
5683
|
|
|
5683
|
-
Defined in: [types.ts:
|
|
5684
|
+
Defined in: [types.ts:509](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L509)
|
|
5684
5685
|
|
|
5685
5686
|
#### Extends
|
|
5686
5687
|
|
|
@@ -5690,10 +5691,10 @@ Defined in: [types.ts:504](https://github.com/adumesny/gridstack.js/blob/master/
|
|
|
5690
5691
|
|
|
5691
5692
|
| Property | Type | Inherited from | Defined in |
|
|
5692
5693
|
| ------ | ------ | ------ | ------ |
|
|
5693
|
-
| <a id="height"></a> `height` | `number` | [`Size`](#size-1).[`height`](#height-1) | [types.ts:
|
|
5694
|
-
| <a id="left-2"></a> `left` | `number` | [`Position`](#position-1).[`left`](#left-1) | [types.ts:
|
|
5695
|
-
| <a id="top-2"></a> `top` | `number` | [`Position`](#position-1).[`top`](#top-1) | [types.ts:
|
|
5696
|
-
| <a id="width"></a> `width` | `number` | [`Size`](#size-1).[`width`](#width-1) | [types.ts:
|
|
5694
|
+
| <a id="height"></a> `height` | `number` | [`Size`](#size-1).[`height`](#height-1) | [types.ts:503](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L503) |
|
|
5695
|
+
| <a id="left-2"></a> `left` | `number` | [`Position`](#position-1).[`left`](#left-1) | [types.ts:507](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L507) |
|
|
5696
|
+
| <a id="top-2"></a> `top` | `number` | [`Position`](#position-1).[`top`](#top-1) | [types.ts:506](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L506) |
|
|
5697
|
+
| <a id="width"></a> `width` | `number` | [`Size`](#size-1).[`width`](#width-1) | [types.ts:502](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L502) |
|
|
5697
5698
|
|
|
5698
5699
|
***
|
|
5699
5700
|
|
|
@@ -5722,7 +5723,7 @@ NOTE: Make sure to include the appropriate CSS (gridstack-extra.css) to support
|
|
|
5722
5723
|
<a id="size-1"></a>
|
|
5723
5724
|
### Size
|
|
5724
5725
|
|
|
5725
|
-
Defined in: [types.ts:
|
|
5726
|
+
Defined in: [types.ts:501](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L501)
|
|
5726
5727
|
|
|
5727
5728
|
#### Extended by
|
|
5728
5729
|
|
|
@@ -5732,8 +5733,8 @@ Defined in: [types.ts:496](https://github.com/adumesny/gridstack.js/blob/master/
|
|
|
5732
5733
|
|
|
5733
5734
|
| Property | Type | Defined in |
|
|
5734
5735
|
| ------ | ------ | ------ |
|
|
5735
|
-
| <a id="height-1"></a> `height` | `number` | [types.ts:
|
|
5736
|
-
| <a id="width-1"></a> `width` | `number` | [types.ts:
|
|
5736
|
+
| <a id="height-1"></a> `height` | `number` | [types.ts:503](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L503) |
|
|
5737
|
+
| <a id="width-1"></a> `width` | `number` | [types.ts:502](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L502) |
|
|
5737
5738
|
|
|
5738
5739
|
## Variables
|
|
5739
5740
|
|
|
@@ -5987,13 +5988,13 @@ Drop event handler that receives previous and new node states
|
|
|
5987
5988
|
### GridStackElement
|
|
5988
5989
|
|
|
5989
5990
|
```ts
|
|
5990
|
-
type GridStackElement = string |
|
|
5991
|
+
type GridStackElement = string | GridItemHTMLElement;
|
|
5991
5992
|
```
|
|
5992
5993
|
|
|
5993
5994
|
Defined in: [types.ts:87](https://github.com/adumesny/gridstack.js/blob/master/src/types.ts#L87)
|
|
5994
5995
|
|
|
5995
5996
|
Type representing various ways to specify grid elements.
|
|
5996
|
-
Can be a CSS selector string,
|
|
5997
|
+
Can be a CSS selector string, GridItemHTMLElement (HTML element with GS variables when loaded).
|
|
5997
5998
|
|
|
5998
5999
|
***
|
|
5999
6000
|
|