Stay organized with collections
Save and categorize content based on your preferences.
blockly > Events > BlockDrag
Events.BlockDrag class
Notifies listeners when a block is being manually dragged/dropped.
Signature:
export declare class BlockDrag extends UiBase
Extends: UiBase
Constructors
Properties
Property |
Modifiers |
Type |
Description |
blockId? |
|
string |
(Optional) The ID of the top-level block being dragged. |
blocks? |
|
Block[] |
(Optional) A list of all of the blocks (i.e. all descendants of the block associated with the block ID) being dragged. |
isStart? |
|
boolean |
(Optional) True if this is the start of a drag, false if this is the end of one. |
type |
|
EventType |
|
Methods
Method |
Modifiers |
Description |
toJson() |
|
Encode the event as JSON. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-16 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eEvents.BlockDrag\u003c/code\u003e class in Blockly notifies listeners when a block is manually dragged or dropped.\u003c/p\u003e\n"],["\u003cp\u003eIt provides information about the dragged block, such as its ID, a list of all descendant blocks being dragged, and whether the event marks the start or end of the drag.\u003c/p\u003e\n"],["\u003cp\u003eThis class extends the \u003ccode\u003eUiBase\u003c/code\u003e class and can be encoded into JSON format for easy handling.\u003c/p\u003e\n"]]],[],null,["[blockly](./blockly.md) \\\u003e [Events](./blockly.events_namespace.md) \\\u003e [BlockDrag](./blockly.events_namespace.blockdrag_class.md)\n\nEvents.BlockDrag class\n----------------------\n\nNotifies listeners when a block is being manually dragged/dropped.\n\n**Signature:** \n\n export declare class BlockDrag extends UiBase \n\n**Extends:** [UiBase](./blockly.events_namespace.uibase_class.md)\n\nConstructors\n------------\n\n| Constructor | Modifiers | Description |\n|--------------------------------------------------------------------------------------------------------------------------------|-----------|----------------------------------------------------|\n| [(constructor)(opt_block, opt_isStart, opt_blocks)](./blockly.events_namespace.blockdrag_class._constructor__1_constructor.md) | | Constructs a new instance of the `BlockDrag` class |\n\nProperties\n----------\n\n| Property | Modifiers | Type | Description |\n|----------------------------------------------------------------------------|-----------|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------|\n| [blockId?](./blockly.events_namespace.blockdrag_class.blockid_property.md) | | string | *(Optional)* The ID of the top-level block being dragged. |\n| [blocks?](./blockly.events_namespace.blockdrag_class.blocks_property.md) | | [Block](./blockly.block_class.md)\\[\\] | *(Optional)* A list of all of the blocks (i.e. all descendants of the block associated with the block ID) being dragged. |\n| [isStart?](./blockly.events_namespace.blockdrag_class.isstart_property.md) | | boolean | *(Optional)* True if this is the start of a drag, false if this is the end of one. |\n| [type](./blockly.events_namespace.blockdrag_class.type_property.md) | | EventType | |\n\nMethods\n-------\n\n| Method | Modifiers | Description |\n|---------------------------------------------------------------------------|-----------|---------------------------|\n| [toJson()](./blockly.events_namespace.blockdrag_class.tojson_1_method.md) | | Encode the event as JSON. |"]]