Stay organized with collections
Save and categorize content based on your preferences.
blockly > blockRendering > register
blockRendering.register() function
Registers a new renderer.
Signature:
export declare function register(name: string, rendererClass: new (name: string) => Renderer): void;
Parameters
| Parameter |
Type |
Description |
| name |
string |
The name of the renderer. |
| rendererClass |
new (name: string) => Renderer |
The new renderer class to register. |
Returns:
void
Exceptions
{Error} if a renderer with the same name has already been registered.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-16 UTC."],[[["\u003cp\u003eRegisters a new renderer class with Blockly's block rendering system using a unique name.\u003c/p\u003e\n"],["\u003cp\u003eThrows an error if attempting to register a renderer with a name that already exists.\u003c/p\u003e\n"],["\u003cp\u003eRequires the renderer's name as a string and the renderer class itself as a function for registration.\u003c/p\u003e\n"]]],[],null,["[blockly](./blockly.md) \\\u003e [blockRendering](./blockly.blockrendering_namespace.md) \\\u003e [register](./blockly.blockrendering_namespace.register_1_function.md)\n\nblockRendering.register() function\n----------------------------------\n\nRegisters a new renderer.\n\n**Signature:** \n\n export declare function register(name: string, rendererClass: new (name: string) =\u003e Renderer): void;\n\nParameters\n----------\n\n| Parameter | Type | Description |\n|---------------|-----------------------------------------------------------------------------------------|-------------------------------------|\n| name | string | The name of the renderer. |\n| rendererClass | new (name: string) =\\\u003e [Renderer](./blockly.blockrendering_namespace.renderer_class.md) | The new renderer class to register. |\n\n**Returns:**\n\nvoid\n\nExceptions\n----------\n\n{Error} if a renderer with the same name has already been registered."]]
