blockly/core/events/events_block_create.d.ts

Blockly is a library for building visual programming editors.

/**
 * @license
 * Copyright 2018 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */
/**
 * Class for a block creation event.
 *
 * @class
 */
import type { Block } from '../block.js';
import * as blocks from '../serialization/blocks.js';
import { Workspace } from '../workspace.js';
import { BlockBase, BlockBaseJson } from './events_block_base.js';
import { EventType } from './type.js';
/**
 * Notifies listeners when a block (or connected stack of blocks) is
 * created.
 */
export declare class BlockCreate extends BlockBase {
    type: EventType;
    /** The XML representation of the created block(s). */
    xml?: Element | DocumentFragment;
    /** 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);
    /**
     * Encode the event as JSON.
     *
     * @returns JSON representation.
     */
    toJson(): BlockCreateJson;
    /**
     * Deserializes the JSON event.
     *
     * @param event The event to append new properties to. Should be a subclass
     *     of BlockCreate, but we can't specify that due to the fact that
     *     parameters to static methods in subclasses must be supertypes of
     *     parameters to static methods in superclasses.
     * @internal
     */
    static fromJson(json: BlockCreateJson, workspace: Workspace, event?: any): BlockCreate;
    /**
     * Run a creation event.
     *
     * @param forward True if run forward, false if run backward (undo).
     */
    run(forward: boolean): void;
}
export interface BlockCreateJson extends BlockBaseJson {
    xml: string;
    ids: string[];
    json: object;
    recordUndo?: boolean;
}
//# sourceMappingURL=events_block_create.d.ts.map