Stay organized with collections
Save and categorize content based on your preferences.
blockly > Events > BlockChange
Events.BlockChange class
Notifies listeners when some element of a block has changed (e.g. field values, comments, etc).
Signature:
export declare class BlockChange extends BlockBase
Extends: BlockBase
Constructors
Properties
| Property |
Modifiers |
Type |
Description |
| element? |
|
string |
(Optional) The element that changed; one of 'field', 'comment', 'collapsed', 'disabled', 'inline', or 'mutation' |
| name? |
|
string |
(Optional) The name of the field that changed, if this is a change to a field. |
| newValue |
|
unknown |
The new value of the element. |
| oldValue |
|
unknown |
The original value of the element. |
| type |
|
string |
|
Methods
| Method |
Modifiers |
Description |
| isNull() |
|
Does this event record any change of state? |
| run(forward) |
|
Run a change event. |
| setDisabledReason(disabledReason) |
|
Set the language-neutral identifier for the reason why the block was or was not disabled. This is only valid for events where element is 'disabled'. Defaults to 'MANUALLY_DISABLED'. |
| 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 2024-09-18 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 2024-09-18 UTC."],[[["The `BlockChange` class in Blockly alerts listeners about modifications to a block's elements such as field values, comments, etc."],["It extends the `BlockBase` class and provides properties like `element`, `name`, `newValue`, and `oldValue` to describe the change."],["`BlockChange` events can indicate alterations to fields, comments, collapsed state, disabled state, inline status, or mutations within a block."],["The `run` method executes the change event, while `toJson` encodes it into JSON format for storage or transmission."],["Developers can use `isNull` to check if the event represents an actual change in the block's state and `setDisabledReason` for events related to a block's disabled status."]]],[]]
