Class Renderer

name

overrides

createDom

• createDom(svg: SVGElement, theme: Blockly.Theme): void

  Create any DOM elements that this renderer needs.

  Parameters

  • svg: SVGElement

    The root of the workspace's SVG.

  • theme: Blockly.Theme

    The workspace theme object.

  Returns void

  Package

dispose

• dispose(): void

  Dispose of this renderer. Delete all DOM elements that this renderer and its constants created.

  Returns void

  Package

getClassName

• getClassName(): string

  Gets the class name that identifies this renderer.

  Returns string

  The CSS class name.

  Package

getConnectionPreviewMethod

• getConnectionPreviewMethod(
      closest: Blockly.RenderedConnection,
      local: Blockly.RenderedConnection,
      topBlock: Blockly.BlockSvg,
  ): PREVIEW_TYPE

  Chooses a connection preview method based on the available connection, the current dragged connection, and the block being dragged.

  Parameters

  • closest: Blockly.RenderedConnection

    The available connection.

  • local: Blockly.RenderedConnection

    The connection currently being dragged.

  • topBlock: Blockly.BlockSvg

    The block currently being dragged.

  Returns PREVIEW_TYPE

  The preview type to display.

  Package

getConstants

• getConstants(): ConstantProvider

  Get the current renderer's constant provider. We assume that when this is called, the renderer has already been initialized.

  Returns ConstantProvider

  The constant provider.

  Package

init

• init(theme: Blockly.Theme, opt_rendererOverrides?: Object): void

  Initialize the renderer.

  Parameters

  • theme: Blockly.Theme

    The workspace theme object.

  • Optionalopt_rendererOverrides: Object

    Rendering constant overrides.

  Returns void

  Package

makeMarkerDrawer

• makeMarkerDrawer(
      workspace: WorkspaceSvg,
      marker: Marker,
  ): Blockly.blockRendering.MarkerSvg

  Create a new instance of the renderer's marker drawer.

  Parameters

  • workspace: WorkspaceSvg

    The workspace the marker belongs to.

  • marker: Marker

    The marker.

  Returns Blockly.blockRendering.MarkerSvg

  The object in charge of drawing the marker.

  Package

makePathObject

• makePathObject(root: SVGElement, style: BlockStyle): IPathObject

  Create a new instance of a renderer path object.

  Parameters

  • root: SVGElement

    The root SVG element.

  • style: BlockStyle

    The style object to use for colouring.

  Returns IPathObject

  The renderer path object.

  Package

orphanCanConnectAtEnd

• orphanCanConnectAtEnd(
      topBlock: Blockly.BlockSvg,
      orphanBlock: Blockly.BlockSvg,
      localType: number,
  ): boolean

  Checks if an orphaned block can connect to the "end" of the topBlock's block-clump. If the clump is a row the end is the last input. If the clump is a stack, the end is the last next connection. If the clump is neither, then this returns false.

  Parameters

  • topBlock: Blockly.BlockSvg

    The top block of the block clump we want to try and connect to.

  • orphanBlock: Blockly.BlockSvg

    The orphan block that wants to find a home.

  • localType: number

    The type of the connection being dragged.

  Returns boolean

  Whether there is a home for the orphan or not.

  Package

refreshDom

• refreshDom(svg: SVGElement, theme: Blockly.Theme): void

  Refresh the renderer after a theme change.

  Parameters

  • svg: SVGElement

    The root of the workspace's SVG.

  • theme: Blockly.Theme

    The workspace theme object.

  Returns void

  Package

render

• render(block: Blockly.BlockSvg): void

  Render the block.

  Parameters

  • block: Blockly.BlockSvg

    The block to render.

  Returns void

  Package

shouldHighlightConnection

• shouldHighlightConnection(_conn: Blockly.Connection): boolean

  Determine whether or not to highlight a connection.

  Parameters

  • _conn: Blockly.Connection

    The connection to determine whether or not to highlight.

  Returns boolean

  True if we should highlight the connection.

  Package