sesaparcours
    Preparing search index...

    Interface IFlyout

    interface IFlyout {
        autoClose: boolean;
        CORNER_RADIUS: number;
        dispose: any;
        hide: any;
        horizontalLayout: boolean;
        MARGIN: number;
        reflow: any;
        RTL: boolean;
        targetWorkspace: WorkspaceSvg;
        createBlock(originalBlock: Blockly.BlockSvg): Blockly.BlockSvg;
        createDom(
            tagName:
                | string
                | Blockly.utils.Svg<SVGGElement>
                | Blockly.utils.Svg<SVGSVGElement>,
        ): SVGElement;
        getHeight(): number;
        getWidth(): number;
        getWorkspace(): WorkspaceSvg;
        getX(): number;
        getY(): number;
        init(targetWorkspace: WorkspaceSvg): void;
        isDragTowardWorkspace(
            currentDragDeltaXY: Blockly.utils.Coordinate,
        ): boolean;
        isScrollable(): boolean;
        isVisible(): boolean;
        position(): void;
        setContainerVisible(visible: boolean): void;
        setVisible(visible: boolean): void;
        show(flyoutDef: string | FlyoutDefinition): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    autoClose CORNER_RADIUS dispose hide horizontalLayout MARGIN reflow RTL targetWorkspace

    Methods

    createBlock createDom getHeight getWidth getWorkspace getX getY init isDragTowardWorkspace isScrollable isVisible position setContainerVisible setVisible show

    Properties

    autoClose: boolean

    Does the flyout automatically close when a block is created?

    CORNER_RADIUS: number

    Corner radius of the flyout background.

    dispose: any

    Dispose of this flyout. Unlink from all DOM elements to prevent memory leaks.

    hide: any

    Hide and empty the flyout.

    horizontalLayout: boolean

    Whether the flyout is laid out horizontally or not.

    MARGIN: number

    Margin around the edges of the blocks in the flyout.

    reflow: any

    Reflow blocks and their mats.

    RTL: boolean

    Is RTL vs LTR.

    targetWorkspace: WorkspaceSvg

    The target workspace

    Methods

    • Create a copy of this block on the workspace.

      Parameters

      Returns Blockly.BlockSvg

      The newly created block.

      if something went wrong with deserialization.

    • Get the height of the flyout.

      Returns number

      The width of the flyout.

    • Get the width of the flyout.

      Returns number

      The width of the flyout.

    • Get the workspace inside the flyout.

      Returns WorkspaceSvg

      The workspace inside the flyout.

    • Calculates the x coordinate for the flyout position.

      Returns number

      X coordinate.

    • Calculates the y coordinate for the flyout position.

      Returns number

      Y coordinate.

    • Initializes the flyout.

      Parameters

      • targetWorkspace: WorkspaceSvg

        The workspace in which to create new blocks.

      Returns void

    • Determine if a drag delta is toward the workspace, based on the position and orientation of the flyout. This is used in determineDragIntention_ to determine if a new block should be created or if the flyout should scroll.

      Parameters

      • currentDragDeltaXY: Blockly.utils.Coordinate

        How far the pointer has moved from the position at mouse down, in pixel units.

      Returns boolean

      True if the drag is toward the workspace.

    • Returns boolean

      True if this flyout may be scrolled with a scrollbar or by dragging.

    • Is the flyout visible?

      Returns boolean

      True if visible.

    • Position the flyout.

      Returns void

    • Set whether this flyout's container is visible.

      Parameters

      • visible: boolean

        Whether the container is visible.

      Returns void

    • Set whether the flyout is visible. A value of true does not necessarily mean that the flyout is shown. It could be hidden because its container is hidden.

      Parameters

      • visible: boolean

        True if visible.

      Returns void

    • Show and populate the flyout.

      Parameters

      • flyoutDef: string | FlyoutDefinition

        Contents to display in the flyout. This is either an array of Nodes, a NodeList, a toolbox definition, or a string with the name of the dynamic category.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods