blockly 9.2.1 → 9.3.0-beta.0

package/core/block_dragger.d.ts

@@ -40,7 +40,7 @@ export declare class BlockDragger implements IBlockDragger {
      */
     dispose(): void;
     /**
-     * Start dragging a block.  This includes moving it to the drag surface.
+     * Start dragging a block.
      *
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at mouse down, in pixel units.

package/core/block_svg.d.ts

@@ -89,7 +89,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     outputConnection: RenderedConnection;
     nextConnection: RenderedConnection;
     previousConnection: RenderedConnection;
-    private readonly useDragSurface_;
+    private translation;
     /**
      * @param workspace The block's workspace.
      * @param prototypeName Name of the language object containing type-specific
@@ -164,13 +164,11 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      */
     translate(x: number, y: number): void;
     /**
-     * Move this block to its workspace's drag surface, accounting for
-     * positioning. Generally should be called at the same time as
-     * setDragging_(true). Does nothing if useDragSurface_ is false.
+     * Returns the SVG translation of this block.
      *
      * @internal
      */
-    moveToDragSurface(): void;
+    getTranslation(): string;
     /**
      * Move a block to a position.
      *
@@ -178,18 +176,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      */
     moveTo(xy: Coordinate): void;
     /**
-     * Move this block back to the workspace block canvas.
-     * Generally should be called at the same time as setDragging_(false).
-     * Does nothing if useDragSurface_ is false.
-     *
-     * @param newXY The position the block should take on on the workspace canvas,
-     *     in workspace coordinates.
-     * @internal
-     */
-    moveOffDragSurface(newXY: Coordinate): void;
-    /**
-     * Move this block during a drag, taking into account whether we are using a
-     * drag surface to translate blocks.
+     * Move this block during a drag.
      * This block must be a top-level block.
      *
      * @param newLoc The location to translate to, in workspace coordinates.

package/core/blockly.d.ts

@@ -10,7 +10,6 @@ import './events/events_ui_base.js';
 import './events/events_var_create.js';
 import { Block } from './block.js';
 import * as blockAnimations from './block_animations.js';
-import { BlockDragSurfaceSvg } from './block_drag_surface.js';
 import { BlockDragger } from './block_dragger.js';
 import { BlockSvg } from './block_svg.js';
 import { BlocklyOptions } from './blockly_options.js';
@@ -84,6 +83,7 @@ import { IFlyout } from './interfaces/i_flyout.js';
 import { IKeyboardAccessible } from './interfaces/i_keyboard_accessible.js';
 import { IMetricsManager } from './interfaces/i_metrics_manager.js';
 import { IMovable } from './interfaces/i_movable.js';
+import { IObservable, isObservable } from './interfaces/i_observable.js';
 import { IPositionable } from './interfaces/i_positionable.js';
 import { IRegistrable } from './interfaces/i_registrable.js';
 import { ISelectable } from './interfaces/i_selectable.js';
@@ -141,7 +141,6 @@ import { Workspace } from './workspace.js';
 import { WorkspaceAudio } from './workspace_audio.js';
 import { WorkspaceComment } from './workspace_comment.js';
 import { WorkspaceCommentSvg } from './workspace_comment_svg.js';
-import { WorkspaceDragSurfaceSvg } from './workspace_drag_surface_svg.js';
 import { WorkspaceDragger } from './workspace_dragger.js';
 import { WorkspaceSvg } from './workspace_svg.js';
 import * as Xml from './xml.js';
@@ -446,7 +445,6 @@ export { BasicCursor };
 export { Block };
 export { BlocklyOptions };
 export { BlockDragger };
-export { BlockDragSurfaceSvg };
 export { BlockSvg };
 export { Blocks };
 export { Bubble };
@@ -507,6 +505,7 @@ export { IMetricsManager };
 export { IMovable };
 export { Input };
 export { InsertionMarkerManager };
+export { IObservable, isObservable };
 export { IPositionable };
 export { IRegistrable };
 export { ISelectable };
@@ -543,7 +542,6 @@ export { Workspace };
 export { WorkspaceAudio };
 export { WorkspaceComment };
 export { WorkspaceCommentSvg };
-export { WorkspaceDragSurfaceSvg };
 export { WorkspaceDragger };
 export { WorkspaceSvg };
 export { ZoomControls };

package/core/bubble.d.ts

@@ -3,7 +3,6 @@
  * Copyright 2012 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { BlockDragSurfaceSvg } from './block_drag_surface.js';
 import type { BlockSvg } from './block_svg.js';
 import type { IBubble } from './interfaces/i_bubble.js';
 import { Coordinate } from './utils/coordinate.js';
@@ -254,15 +253,12 @@ export declare class Bubble implements IBubble {
     /** Dispose of this bubble. */
     dispose(): void;
     /**
-     * Move this bubble during a drag, taking into account whether or not there is
-     * a drag surface.
+     * Move this bubble during a drag.
      *
-     * @param dragSurface The surface that carries rendered items during a drag,
-     *     or null if no drag surface is in use.
      * @param newLoc The location to translate to, in workspace coordinates.
      * @internal
      */
-    moveDuringDrag(dragSurface: BlockDragSurfaceSvg, newLoc: Coordinate): void;
+    moveDuringDrag(newLoc: Coordinate): void;
     /**
      * Return the coordinates of the top-left corner of this bubble's body
      * relative to the drawing surface's origin (0,0), in workspace units.

package/core/bubble_dragger.d.ts

@@ -21,14 +21,13 @@ export declare class BubbleDragger {
     /** Whether the bubble would be deleted if dropped immediately. */
     private wouldDeleteBubble_;
     private readonly startXY_;
-    private dragSurface_;
     /**
      * @param bubble The item on the bubble canvas to drag.
      * @param workspace The workspace to drag on.
      */
     constructor(bubble: IBubble, workspace: WorkspaceSvg);
     /**
-     * Start dragging a bubble.  This includes moving it to the drag surface.
+     * Start dragging a bubble.
      *
      * @internal
      */

package/core/events/events.d.ts

@@ -3,7 +3,7 @@
  * Copyright 2016 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
+import { Abstract, AbstractEventJson } from './events_abstract.js';
 import { BlockBase, BlockBaseJson } from './events_block_base.js';
 import { BlockChange, BlockChangeJson } from './events_block_change.js';
 import { BlockCreate, BlockCreateJson } from './events_block_create.js';
@@ -18,16 +18,6 @@ import { CommentCreate, CommentCreateJson } from './events_comment_create.js';
 import { CommentDelete } from './events_comment_delete.js';
 import { CommentMove, CommentMoveJson } from './events_comment_move.js';
 import { MarkerMove, MarkerMoveJson } from './events_marker_move.js';
-import { ProcedureBase } from './events_procedure_base.js';
-import { ProcedureChangeReturn } from './events_procedure_change_return.js';
-import { ProcedureCreate } from './events_procedure_create.js';
-import { ProcedureDelete } from './events_procedure_delete.js';
-import { ProcedureEnable } from './events_procedure_enable.js';
-import { ProcedureRename } from './events_procedure_rename.js';
-import { ProcedureParameterBase } from './events_procedure_parameter_base.js';
-import { ProcedureParameterCreate } from './events_procedure_parameter_create.js';
-import { ProcedureParameterDelete } from './events_procedure_parameter_delete.js';
-import { ProcedureParameterRename } from './events_procedure_parameter_rename.js';
 import { Selected, SelectedJson } from './events_selected.js';
 import { ThemeChange, ThemeChangeJson } from './events_theme_change.js';
 import { ToolboxItemSelect, ToolboxItemSelectJson } from './events_toolbox_item_select.js';
@@ -41,7 +31,7 @@ import { VarRename, VarRenameJson } from './events_var_rename.js';
 import { ViewportChange, ViewportChangeJson } from './events_viewport.js';
 import * as eventUtils from './utils.js';
 import { FinishedLoading, FinishedLoadingJson } from './workspace_events.js';
-export declare const Abstract: typeof AbstractEvent;
+export { Abstract };
 export { AbstractEventJson };
 export { BubbleOpen };
 export { BubbleOpenJson };
@@ -74,16 +64,6 @@ export { FinishedLoading };
 export { FinishedLoadingJson };
 export { MarkerMove };
 export { MarkerMoveJson };
-export { ProcedureBase };
-export { ProcedureChangeReturn };
-export { ProcedureCreate };
-export { ProcedureDelete };
-export { ProcedureEnable };
-export { ProcedureRename };
-export { ProcedureParameterBase };
-export { ProcedureParameterCreate };
-export { ProcedureParameterDelete };
-export { ProcedureParameterRename };
 export { Selected };
 export { SelectedJson };
 export { ThemeChange };

package/core/events/events_abstract.d.ts

@@ -17,7 +17,14 @@ export declare abstract class Abstract {
     abstract isBlank: boolean;
     /** The workspace identifier for this event. */
     workspaceId?: string;
+    /**
+     * An ID for the group of events this block is associated with.
+     *
+     * Groups define events that should be treated as an single action from the
+     * user's perspective, and should be undone together.
+     */
     group: string;
+    /** Whether this event is undoable or not. */
     recordUndo: boolean;
     /** Whether or not the event is a UI event. */
     isUiEvent: boolean;

package/core/events/events_block_base.d.ts

@@ -7,12 +7,13 @@ import type { Block } from '../block.js';
 import type { Workspace } from '../workspace.js';
 import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
 /**
- * Abstract class for a block event.
+ * Abstract class for any event related to blocks.
  *
  * @alias Blockly.Events.BlockBase
  */
 export declare class BlockBase extends AbstractEvent {
     isBlank: boolean;
+    /** The ID of the block associated with this event. */
     blockId?: string;
     /**
      * @param opt_block The block this event corresponds to.

package/core/events/events_block_change.d.ts

@@ -8,15 +8,23 @@ import type { BlockSvg } from '../block_svg.js';
 import { Workspace } from '../workspace.js';
 import { BlockBase, BlockBaseJson } from './events_block_base.js';
 /**
- * Class for a block change event.
+ * Notifies listeners when some element of a block has changed (e.g.
+ * field values, comments, etc).
  *
  * @alias Blockly.Events.BlockChange
  */
 export declare class BlockChange extends BlockBase {
     type: string;
+    /**
+     * The element that changed; one of 'field', 'comment', 'collapsed',
+     * 'disabled', 'inline', or 'mutation'
+     */
     element?: string;
+    /** The name of the field that changed, if this is a change to a field. */
     name?: string;
+    /** The original value of the element. */
     oldValue: unknown;
+    /** The new value of the element. */
     newValue: unknown;
     /**
      * @param opt_block The changed block.  Undefined for a blank event.

package/core/events/events_block_create.d.ts

@@ -8,15 +8,19 @@ import * as blocks from '../serialization/blocks.js';
 import { BlockBase, BlockBaseJson } from './events_block_base.js';
 import { Workspace } from '../workspace.js';
 /**
- * Class for a block creation event.
+ * Notifies listeners when a block (or connected stack of blocks) is
+ * created.
  *
  * @alias Blockly.Events.BlockCreate
  */
 export declare class BlockCreate extends BlockBase {
     type: string;
+    /** The XML representation of the created block(s). */
     xml?: Element | DocumentFragment;
-    ids?: string[];
+    /** The JSON respresentation of the created block(s). */
     json?: blocks.State;
+    /** All of the IDs of created blocks. */
+    ids?: string[];
     /** @param opt_block The created block.  Undefined for a blank event. */
     constructor(opt_block?: Block);
     /**

package/core/events/events_block_delete.d.ts

@@ -8,15 +8,20 @@ import * as blocks from '../serialization/blocks.js';
 import { BlockBase, BlockBaseJson } from './events_block_base.js';
 import { Workspace } from '../workspace.js';
 /**
- * Class for a block deletion event.
+ * Notifies listeners when a block (or connected stack of blocks) is
+ * deleted.
  *
  * @alias Blockly.Events.BlockDelete
  */
 export declare class BlockDelete extends BlockBase {
+    /** The XML representation of the deleted block(s). */
     oldXml?: Element | DocumentFragment;
+    /** The JSON respresentation of the deleted block(s). */
+    oldJson?: blocks.State;
+    /** All of the IDs of deleted blocks. */
     ids?: string[];
+    /** True if the deleted block was a shadow block, false otherwise. */
     wasShadow?: boolean;
-    oldJson?: blocks.State;
     type: string;
     /** @param opt_block The deleted block.  Undefined for a blank event. */
     constructor(opt_block?: Block);

package/core/events/events_block_drag.d.ts

@@ -8,13 +8,19 @@ import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 import { Workspace } from '../workspace.js';
 /**
- * Class for a block drag event.
+ * Notifies listeners when a block is being manually dragged/dropped.
  *
  * @alias Blockly.Events.BlockDrag
  */
 export declare class BlockDrag extends UiBase {
+    /** The ID of the top-level block being dragged. */
     blockId?: string;
+    /** True if this is the start of a drag, false if this is the end of one. */
     isStart?: boolean;
+    /**
+     * A list of all of the blocks (i.e. all descendants of the block associated
+     * with the block ID) being dragged.
+     */
     blocks?: Block[];
     type: string;
     /**

package/core/events/events_block_move.d.ts

@@ -8,17 +8,36 @@ import { Coordinate } from '../utils/coordinate.js';
 import { BlockBase, BlockBaseJson } from './events_block_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a block move event.  Created before the move.
+ * Notifies listeners when a block is moved. This could be from one
+ * connection to another, or from one location on the workspace to another.
  *
  * @alias Blockly.Events.BlockMove
  */
 export declare class BlockMove extends BlockBase {
     type: string;
+    /** The ID of the old parent block. Undefined if it was a top-level block. */
     oldParentId?: string;
+    /**
+     * The name of the old input. Undefined if it was a top-level block or the
+     * parent's next block.
+     */
     oldInputName?: string;
+    /**
+     * The old X and Y workspace coordinates of the block if it was a top level
+     * block. Undefined if it was not a top level block.
+     */
     oldCoordinate?: Coordinate;
+    /** The ID of the new parent block. Undefined if it is a top-level block. */
     newParentId?: string;
+    /**
+     * The name of the new input. Undefined if it is a top-level block or the
+     * parent's next block.
+     */
     newInputName?: string;
+    /**
+     * The new X and Y workspace coordinates of the block if it is a top level
+     * block. Undefined if it is not a top level block.
+     */
     newCoordinate?: Coordinate;
     /** @param opt_block The moved block.  Undefined for a blank event. */
     constructor(opt_block?: Block);

package/core/events/events_bubble_open.d.ts

@@ -13,8 +13,11 @@ import type { Workspace } from '../workspace.js';
  * @alias Blockly.Events.BubbleOpen
  */
 export declare class BubbleOpen extends UiBase {
+    /** The ID of the block the bubble is attached to. */
     blockId?: string;
+    /** True if the bubble is opening, false if closing. */
     isOpen?: boolean;
+    /** The type of bubble; one of 'mutator', 'comment', or 'warning'. */
     bubbleType?: BubbleType;
     type: string;
     /**

package/core/events/events_click.d.ts

@@ -8,12 +8,17 @@ import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 import { Workspace } from '../workspace.js';
 /**
- * Class for a click event.
+ * Notifies listeners that ome blockly element was clicked.
  *
  * @alias Blockly.Events.Click
  */
 export declare class Click extends UiBase {
+    /** The ID of the block that was clicked, if a block was clicked. */
     blockId?: string;
+    /**
+     * The type of element that was clicked; one of 'block', 'workspace',
+     * or 'zoom_controls'.
+     */
     targetType?: ClickTarget;
     type: string;
     /**

package/core/events/events_comment_base.d.ts

@@ -15,6 +15,7 @@ import type { Workspace } from '../workspace.js';
  */
 export declare class CommentBase extends AbstractEvent {
     isBlank: boolean;
+    /** The ID of the comment that this event references. */
     commentId?: string;
     /**
      * @param opt_comment The comment this event corresponds to.  Undefined for a

package/core/events/events_comment_change.d.ts

@@ -7,13 +7,15 @@ import type { WorkspaceComment } from '../workspace_comment.js';
 import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a comment change event.
+ * Notifies listeners that the contents of a workspace comment has changed.
  *
  * @alias Blockly.Events.CommentChange
  */
 export declare class CommentChange extends CommentBase {
     type: string;
+    /** The previous contents of the comment. */
     oldContents_?: string;
+    /** The new contents of the comment. */
     newContents_?: string;
     /**
      * @param opt_comment The comment that is being changed.  Undefined for a

package/core/events/events_comment_create.d.ts

@@ -7,12 +7,13 @@ import type { WorkspaceComment } from '../workspace_comment.js';
 import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a comment creation event.
+ * Notifies listeners that a workspace comment was created.
  *
  * @alias Blockly.Events.CommentCreate
  */
 export declare class CommentCreate extends CommentBase {
     type: string;
+    /** The XML representation of the created workspace comment. */
     xml?: Element | DocumentFragment;
     /**
      * @param opt_comment The created comment.

package/core/events/events_comment_delete.d.ts

@@ -7,12 +7,13 @@ import type { WorkspaceComment } from '../workspace_comment.js';
 import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a comment deletion event.
+ * Notifies listeners that a workspace comment has been deleted.
  *
  * @alias Blockly.Events.CommentDelete
  */
 export declare class CommentDelete extends CommentBase {
     type: string;
+    /** The XML representation of the deleted workspace comment. */
     xml?: Element;
     /**
      * @param opt_comment The deleted comment.

package/core/events/events_comment_move.d.ts

@@ -8,15 +8,17 @@ import type { WorkspaceComment } from '../workspace_comment.js';
 import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a comment move event.  Created before the move.
+ * Notifies listeners that a workspace comment has moved.
  *
  * @alias Blockly.Events.CommentMove
  */
 export declare class CommentMove extends CommentBase {
     type: string;
+    /** The comment that is being moved. */
     comment_?: WorkspaceComment;
+    /** The location of the comment before the move, in workspace coordinates. */
     oldCoordinate_?: Coordinate;
-    /** The location after the move, in workspace coordinates. */
+    /** The location of the comment after the move, in workspace coordinates. */
     newCoordinate_?: Coordinate;
     /**
      * @param opt_comment The comment that is being moved.  Undefined for a blank

package/core/events/events_marker_move.d.ts

@@ -9,14 +9,23 @@ import type { Workspace } from '../workspace.js';
 import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 /**
- * Class for a marker move event.
+ * Notifies listeners that a marker (used for keyboard navigation) has
+ * moved.
  *
  * @alias Blockly.Events.MarkerMove
  */
 export declare class MarkerMove extends UiBase {
+    /** The ID of the block the marker is now on, if any. */
     blockId?: string;
+    /** The old node the marker used to be on, if any. */
     oldNode?: ASTNode;
+    /** The new node the marker is now on. */
     newNode?: ASTNode;
+    /**
+     * True if this is a cursor event, false otherwise.
+     * For information about cursors vs markers see {@link
+     * https://blocklycodelabs.dev/codelabs/keyboard-navigation/index.html?index=..%2F..index#1}.
+     */
     isCursor?: boolean;
     type: string;
     /**

package/core/events/events_selected.d.ts

@@ -8,11 +8,17 @@ import { UiBase } from './events_ui_base.js';
 import type { Workspace } from '../workspace.js';
 /**
  * Class for a selected event.
+ * Notifies listeners that a new element has been selected.
  *
  * @alias Blockly.Events.Selected
  */
 export declare class Selected extends UiBase {
+    /** The id of the last selected selectable element. */
     oldElementId?: string;
+    /**
+     * The id of the newly selected selectable element,
+     * or undefined if unselected.
+     */
     newElementId?: string;
     type: string;
     /**

package/core/events/events_theme_change.d.ts

@@ -7,11 +7,12 @@ import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a theme change event.
+ * Notifies listeners that the workspace theme has changed.
  *
  * @alias Blockly.Events.ThemeChange
  */
 export declare class ThemeChange extends UiBase {
+    /** The name of the new theme that has been set. */
     themeName?: string;
     type: string;
     /**

package/core/events/events_toolbox_item_select.d.ts

@@ -7,12 +7,14 @@ import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a toolbox item select event.
+ * Notifies listeners that a toolbox item has been selected.
  *
  * @alias Blockly.Events.ToolboxItemSelect
  */
 export declare class ToolboxItemSelect extends UiBase {
+    /** The previously selected toolbox item. */
     oldItem?: string;
+    /** The newly selected toolbox item. */
     newItem?: string;
     type: string;
     /**

package/core/events/events_trashcan_open.d.ts

@@ -7,11 +7,15 @@ import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a trashcan open event.
+ * Notifies listeners when the trashcan is opening or closing.
  *
  * @alias Blockly.Events.TrashcanOpen
  */
 export declare class TrashcanOpen extends UiBase {
+    /**
+     * True if the trashcan is currently opening (previously closed).
+     * False if it is currently closing (previously open).
+     */
     isOpen?: boolean;
     type: string;
     /**

package/core/events/events_var_base.d.ts

@@ -13,6 +13,7 @@ import type { Workspace } from '../workspace.js';
  */
 export declare class VarBase extends AbstractEvent {
     isBlank: boolean;
+    /** The ID of the variable this event references. */
     varId?: string;
     /**
      * @param opt_variable The variable this event corresponds to.  Undefined for

package/core/events/events_var_create.d.ts

@@ -7,13 +7,15 @@ import type { VariableModel } from '../variable_model.js';
 import { VarBase, VarBaseJson } from './events_var_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a variable creation event.
+ * Notifies listeners that a variable model has been created.
  *
  * @alias Blockly.Events.VarCreate
  */
 export declare class VarCreate extends VarBase {
     type: string;
+    /** The type of the variable that was created. */
     varType?: string;
+    /** The name of the variable that was created. */
     varName?: string;
     /**
      * @param opt_variable The created variable. Undefined for a blank event.

package/core/events/events_var_delete.d.ts

@@ -7,13 +7,15 @@ import type { VariableModel } from '../variable_model.js';
 import { VarBase, VarBaseJson } from './events_var_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a variable deletion event.
+ * Notifies listeners that a variable model has been deleted.
  *
- * @alias Blockly.Events.VarDelete
+ * @class
  */
 export declare class VarDelete extends VarBase {
     type: string;
+    /** The type of the variable that was deleted. */
     varType?: string;
+    /** The name of the variable that was deleted. */
     varName?: string;
     /**
      * @param opt_variable The deleted variable. Undefined for a blank event.

package/core/events/events_var_rename.d.ts

@@ -7,13 +7,15 @@ import type { VariableModel } from '../variable_model.js';
 import { VarBase, VarBaseJson } from './events_var_base.js';
 import type { Workspace } from '../workspace.js';
 /**
- * Class for a variable rename event.
+ * Notifies listeners that a variable model was renamed.
  *
- * @alias Blockly.Events.VarRename
+ * @class
  */
 export declare class VarRename extends VarBase {
     type: string;
+    /** The previous name of the variable. */
     oldName?: string;
+    /** The new name of the variable. */
     newName?: string;
     /**
      * @param opt_variable The renamed variable. Undefined for a blank event.