blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/block_svg.d.ts

@@ -28,6 +28,7 @@ import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a block's SVG representation.
  * Not normally called directly, workspace.newBlock() is preferred.
+ *
  * @alias Blockly.BlockSvg
  */
 export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBoundedElement, ICopyable, IDraggable {
@@ -47,6 +48,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     customContextMenu?: ((p1: Array<ContextMenuOption | LegacyContextMenuOption>) => any) | null;
     /**
      * An property used internally to reference the block's rendering debugger.
+     *
      * @internal
      */
     renderingDebugger: BlockRenderingDebug | null;
@@ -103,14 +105,16 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     initSvg(): void;
     /**
      * Get the secondary colour of a block.
-     * @return #RRGGBB string.
+     *
+     * @returns #RRGGBB string.
      */
-    getColourSecondary(): string | null;
+    getColourSecondary(): string | undefined;
     /**
      * Get the tertiary colour of a block.
-     * @return #RRGGBB string.
+     *
+     * @returns #RRGGBB string.
      */
-    getColourTertiary(): string | null;
+    getColourTertiary(): string | undefined;
     /**
      * Selects this block. Highlights the block visually and fires a select event
      * if the block is not already selected.
@@ -123,11 +127,13 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     unselect(): void;
     /**
      * Returns a list of mutator, comment, and warning icons.
-     * @return List of icons.
+     *
+     * @returns List of icons.
      */
     getIcons(): Icon[];
     /**
      * Sets the parent of this block to be a new block or null.
+     *
      * @param newParent New parent block.
      * @internal
      */
@@ -138,11 +144,13 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * If the block is on the workspace, (0, 0) is the origin of the workspace
      * coordinate system.
      * This does not change with workspace scale.
-     * @return Object with .x and .y properties in workspace coordinates.
+     *
+     * @returns Object with .x and .y properties in workspace coordinates.
      */
     getRelativeToSurfaceXY(): Coordinate;
     /**
      * Move a block by a relative offset.
+     *
      * @param dx Horizontal offset in workspace units.
      * @param dy Vertical offset in workspace units.
      */
@@ -150,6 +158,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     /**
      * Transforms a block by setting the translation on the transform attribute
      * of the block's SVG.
+     *
      * @param x The x coordinate of the translation in workspace units.
      * @param y The y coordinate of the translation in workspace units.
      */
@@ -158,11 +167,13 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * 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.
+     *
      * @internal
      */
     moveToDragSurface(): void;
     /**
      * Move a block to a position.
+     *
      * @param xy The position to move to in workspace units.
      */
     moveTo(xy: Coordinate): void;
@@ -170,6 +181,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * 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
@@ -179,6 +191,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * Move this block during a drag, taking into account whether we are using a
      * drag surface to translate blocks.
      * This block must be a top-level block.
+     *
      * @param newLoc The location to translate to, in workspace coordinates.
      * @internal
      */
@@ -194,7 +207,8 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * Returns the coordinates of a bounding box describing the dimensions of this
      * block and any blocks stacked below it.
      * Coordinate system: workspace coordinates.
-     * @return Object with coordinates of the bounding box.
+     *
+     * @returns Object with coordinates of the bounding box.
      */
     getBoundingRectangle(): Rect;
     /**
@@ -204,6 +218,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     markDirty(): void;
     /**
      * Set whether the block is collapsed or not.
+     *
      * @param collapsed True if collapsed.
      */
     setCollapsed(collapsed: boolean): void;
@@ -214,27 +229,32 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     private updateCollapsed_;
     /**
      * Open the next (or previous) FieldTextInput.
+     *
      * @param start Current field.
      * @param forward If true go forward, otherwise backward.
      */
     tab(start: Field, forward: boolean): void;
     /**
      * Handle a mouse-down on an SVG block.
+     *
      * @param e Mouse down event or touch start event.
      */
     private onMouseDown_;
     /**
      * Load the block's help page in a new window.
+     *
      * @internal
      */
     showHelp(): void;
     /**
      * Generate the context menu for this block.
-     * @return Context menu options or null if no menu.
+     *
+     * @returns Context menu options or null if no menu.
      */
     protected generateContextMenu(): Array<ContextMenuOption | LegacyContextMenuOption> | null;
     /**
      * Show the context menu for this block.
+     *
      * @param e Mouse event.
      * @internal
      */
@@ -242,6 +262,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     /**
      * Move the connections for this block and all blocks attached under it.
      * Also update any attached bubbles.
+     *
      * @param dx Horizontal offset from current location, in workspace units.
      * @param dy Vertical offset from current location, in workspace units.
      * @internal
@@ -250,22 +271,26 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     /**
      * Recursively adds or removes the dragging class to this node and its
      * children.
+     *
      * @param adding True if adding, false if removing.
      * @internal
      */
     setDragging(adding: boolean): void;
     /**
      * Set whether this block is movable or not.
+     *
      * @param movable True if movable.
      */
     setMovable(movable: boolean): void;
     /**
      * Set whether this block is editable or not.
+     *
      * @param editable True if editable.
      */
     setEditable(editable: boolean): void;
     /**
      * Sets whether this block is a shadow block or not.
+     *
      * @param shadow True if a shadow.
      * @internal
      */
@@ -273,17 +298,20 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     /**
      * Set whether this block is an insertion marker block or not.
      * Once set this cannot be unset.
+     *
      * @param insertionMarker True if an insertion marker.
      * @internal
      */
     setInsertionMarker(insertionMarker: boolean): void;
     /**
      * Return the root node of the SVG or null if none exists.
-     * @return The root SVG node (probably a group).
+     *
+     * @returns The root SVG node (probably a group).
      */
     getSvgRoot(): SVGGElement;
     /**
      * Dispose of this block.
+     *
      * @param healStack If true, then try to heal any gap by connecting the next
      *     statement with the previous statement.  Otherwise, dispose of all
      *     children of this block.
@@ -301,34 +329,40 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     checkAndDelete(): void;
     /**
      * Encode a block for copying.
-     * @return Copy metadata, or null if the block is an insertion marker.
+     *
+     * @returns Copy metadata, or null if the block is an insertion marker.
      * @internal
      */
     toCopyData(): CopyData | null;
     /**
      * Updates the colour of the block to match the block's state.
+     *
      * @internal
      */
     applyColour(): void;
     /**
      * Updates the color of the block (and children) to match the current disabled
      * state.
+     *
      * @internal
      */
     updateDisabled(): void;
     /**
      * Get the comment icon attached to this block, or null if the block has no
      * comment.
-     * @return The comment icon attached to this block, or null.
+     *
+     * @returns The comment icon attached to this block, or null.
      */
     getCommentIcon(): Comment | null;
     /**
      * Set this block's comment text.
+     *
      * @param text The text, or null to delete.
      */
     setCommentText(text: string | null): void;
     /**
      * Set this block's warning text.
+     *
      * @param text The text, or null to delete.
      * @param opt_id An optional ID for the warning text to be able to maintain
      *     multiple warnings.
@@ -336,50 +370,59 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     setWarningText(text: string | null, opt_id?: string): void;
     /**
      * Give this block a mutator dialog.
+     *
      * @param mutator A mutator dialog instance or null to remove.
      */
     setMutator(mutator: Mutator | null): void;
     /**
      * Set whether the block is enabled or not.
+     *
      * @param enabled True if enabled.
      */
     setEnabled(enabled: boolean): void;
     /**
      * Set whether the block is highlighted or not.  Block highlighting is
      * often used to visually mark blocks currently being executed.
+     *
      * @param highlighted True if highlighted.
      */
     setHighlighted(highlighted: boolean): void;
     /**
      * Adds the visual "select" effect to the block, but does not actually select
      * it or fire an event.
+     *
      * @see BlockSvg#select
      */
     addSelect(): void;
     /**
      * Removes the visual "select" effect from the block, but does not actually
      * unselect it or fire an event.
+     *
      * @see BlockSvg#unselect
      */
     removeSelect(): void;
     /**
      * Update the cursor over this block by adding or removing a class.
+     *
      * @param enable True if the delete cursor should be shown, false otherwise.
      * @internal
      */
     setDeleteStyle(enable: boolean): void;
     /**
      * Get the colour of a block.
-     * @return #RRGGBB string.
+     *
+     * @returns #RRGGBB string.
      */
     getColour(): string;
     /**
      * Change the colour of a block.
+     *
      * @param colour HSV hue value, or #RRGGBB string.
      */
     setColour(colour: number | string): void;
     /**
      * Set the style and colour values of a block.
+     *
      * @param blockStyleName Name of the block style.
      * @throws {Error} if the block style does not exist.
      */
@@ -389,11 +432,13 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * <g> tags do not respect z-index so SVG renders them in the
      * order that they are in the DOM.  By placing this block first within the
      * block group's <g>, it will render on top of any other blocks.
+     *
      * @internal
      */
     bringToFront(): void;
     /**
      * Set whether this block can chain onto the bottom of another block.
+     *
      * @param newBoolean True if there can be a previous statement.
      * @param opt_check Statement type or list of statement types.  Null/undefined
      *     if any type could be connected.
@@ -401,6 +446,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     setPreviousStatement(newBoolean: boolean, opt_check?: string | string[] | null): void;
     /**
      * Set whether another block can chain onto the bottom of this block.
+     *
      * @param newBoolean True if there can be a next statement.
      * @param opt_check Statement type or list of statement types.  Null/undefined
      *     if any type could be connected.
@@ -408,6 +454,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     setNextStatement(newBoolean: boolean, opt_check?: string | string[] | null): void;
     /**
      * Set whether this block returns a value.
+     *
      * @param newBoolean True if there is an output.
      * @param opt_check Returned type or list of returned types.  Null or
      *     undefined if any type could be returned (e.g. variable get).
@@ -415,30 +462,34 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     setOutput(newBoolean: boolean, opt_check?: string | string[] | null): void;
     /**
      * Set whether value inputs are arranged horizontally or vertically.
+     *
      * @param newBoolean True if inputs are horizontal.
      */
     setInputsInline(newBoolean: boolean): void;
     /**
      * Remove an input from this block.
+     *
      * @param name The name of the input.
      * @param opt_quiet True to prevent error if input is not present.
-     * @return True if operation succeeds, false if input is not present and
+     * @returns True if operation succeeds, false if input is not present and
      *     opt_quiet is true
      * @throws {Error} if the input is not present and opt_quiet is not true.
      */
     removeInput(name: string, opt_quiet?: boolean): boolean;
     /**
      * Move a numbered input to a different location on this block.
+     *
      * @param inputIndex Index of the input to move.
      * @param refIndex Index of input that should be after the moved input.
      */
     moveNumberedInputBefore(inputIndex: number, refIndex: number): void;
     /**
      * Add a value input, statement input or local variable to this block.
+     *
      * @param type One of Blockly.inputTypes.
      * @param name Language-neutral identifier which may used to find this input
      *     again.  Should be unique to this block.
-     * @return The input object created.
+     * @returns The input object created.
      */
     protected appendInput_(type: number, name: string): Input;
     /**
@@ -447,26 +498,29 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * Used by the deserializer to be more efficient. Setting a connection's
      * tracked_ value to false keeps it from adding itself to the db when it
      * gets its first moveTo call, saving expensive ops for later.
+     *
      * @param track If true, start tracking. If false, stop tracking.
      * @internal
      */
     setConnectionTracking(track: boolean): void;
     /**
      * Returns connections originating from this block.
+     *
      * @param all If true, return all connections even hidden ones.
      *     Otherwise, for a non-rendered block return an empty list, and for a
      * collapsed block don't return inputs connections.
-     * @return Array of connections.
+     * @returns Array of connections.
      * @internal
      */
     getConnections_(all: boolean): RenderedConnection[];
     /**
      * Walks down a stack of blocks and finds the last next connection on the
      * stack.
+     *
      * @param ignoreShadows If true,the last connection on a non-shadow block will
      *     be returned. If false, this will follow shadows to find the last
      *     connection.
-     * @return The last next connection on the stack, or null.
+     * @returns The last next connection on the stack, or null.
      * @internal
      */
     lastConnectionInStack(ignoreShadows: boolean): RenderedConnection | null;
@@ -474,26 +528,30 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * Find the connection on this block that corresponds to the given connection
      * on the other block.
      * Used to match connections between a block and its insertion marker.
+     *
      * @param otherBlock The other block to match against.
      * @param conn The other connection to match.
-     * @return The matching connection on this block, or null.
+     * @returns The matching connection on this block, or null.
      * @internal
      */
     getMatchingConnection(otherBlock: Block, conn: Connection): RenderedConnection | null;
     /**
      * Create a connection of the specified type.
+     *
      * @param type The type of the connection to create.
-     * @return A new connection of the specified type.
+     * @returns A new connection of the specified type.
      */
     protected makeConnection_(type: number): RenderedConnection;
     /**
      * Return the next statement block directly connected to this block.
-     * @return The next statement block or null.
+     *
+     * @returns The next statement block or null.
      */
     getNextBlock(): BlockSvg | null;
     /**
      * Returns the block connected to the previous connection.
-     * @return The previous statement block or null.
+     *
+     * @returns The previous statement block or null.
      */
     getPreviousBlock(): BlockSvg | null;
     /**
@@ -504,6 +562,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     /**
      * Schedule snapping to grid and bumping neighbours to occur after a brief
      * delay.
+     *
      * @internal
      */
     scheduleSnapAndBump(): void;
@@ -511,6 +570,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * Position a block so that it doesn't move the target block when connected.
      * The block to position is usually either the first block in a dragged stack
      * or an insertion marker.
+     *
      * @param sourceConnection The connection on the moving block's stack.
      * @param targetConnection The connection that should stay stationary as this
      *     block is positioned.
@@ -518,7 +578,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      */
     positionNearConnection(sourceConnection: RenderedConnection, targetConnection: RenderedConnection): void;
     /**
-     * @return The first statement connection or null.
+     * @returns The first statement connection or null.
      * @internal
      */
     getFirstStatementConnection(): RenderedConnection | null;
@@ -527,12 +587,14 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * Includes value and statement inputs, as well as any following statement.
      * Excludes any connection on an output tab or any preceding statement.
      * Blocks are optionally sorted by position; top to bottom.
+     *
      * @param ordered Sort the list if true.
-     * @return Array of blocks.
+     * @returns Array of blocks.
      */
     getChildren(ordered: boolean): BlockSvg[];
     /**
      * Lays out and reflows a block based on its contents and settings.
+     *
      * @param opt_bubble If false, just render this block.
      *   If true, also render block's parent, grandparent, etc.  Defaults to true.
      */
@@ -547,6 +609,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     private updateConnectionLocations_;
     /**
      * Add the cursor SVG to this block's SVG group.
+     *
      * @param cursorSvg The SVG root of the cursor to be added to the block SVG
      *     group.
      * @internal
@@ -554,6 +617,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     setCursorSvg(cursorSvg: SVGElement): void;
     /**
      * Add the marker SVG to this block's SVG group.
+     *
      * @param markerSvg The SVG root of the marker to be added to the block SVG
      *     group.
      * @internal
@@ -562,7 +626,8 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     /**
      * Returns a bounding box describing the dimensions of this block
      * and any blocks stacked below it.
-     * @return Object with height and width properties in workspace units.
+     *
+     * @returns Object with height and width properties in workspace units.
      * @internal
      */
     getHeightWidth(): {
@@ -573,6 +638,7 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * Visual effect to show that if the dragging block is dropped, this block
      * will be replaced.  If a shadow block, it will disappear.  Otherwise it will
      * bump.
+     *
      * @param add True if highlighting should be added.
      * @internal
      */
@@ -580,9 +646,11 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
     /**
      * Visual effect to show that if the dragging block is dropped it will connect
      * to this input.
+     *
      * @param conn The connection on the input to highlight.
      * @param add True if highlighting should be added.
      * @internal
      */
-    highlightShapeForInput(conn: Connection, add: boolean): void;
+    highlightShapeForInput(conn: RenderedConnection, add: boolean): void;
 }
+//# sourceMappingURL=block_svg.d.ts.map