块地

blockly 软件包

说明
ASTNode 用于 AST 节点的类。建议使用 createNode 方法之一,而不要直接创建节点。
BasicCursor 用于基本游标的类。这将允许用户通过点击“下一项”或“上一项”来访问 AST 中的所有节点。
屏蔽 用于一个块的类。通常不会直接调用 workspace.newBlock()。
BlockSvg 用于块的 SVG 表示形式的类。通常不会直接调用 workspace.newBlock()。
CodeGenerator 用于将代码块转换为语言的代码生成器的类。
CollapsibleToolboxCategory 工具箱中可收起的类别的类。
ComponentManager 负责管理所有在此工作区中注册的内容。
连接 用于块之间的连接的类。
ConnectionChecker 用于连接类型检查逻辑的类。
ConnectionDB 连接数据库。系统会按照其纵向组件的顺序存储连接。这样,就可以使用二进制搜索快速查询某个区域中的连接。
ContextMenuRegistry 用于上下文菜单项的注册表的类。这将是一个单例。您不应创建新实例,而应仅从 ContextMenuRegistry.registry 访问此类。
Cursor 用于游标的类。光标控制用户如何浏览 Blockly AST。
DeleteArea 一个组件的抽象类,该组件可以删除掉到其上方的块或气泡。
DragTarget 当某个块或气泡在其上面拖动或放下时,具有自定义行为的组件的抽象类。
FieldCheckbox 用于复选框字段的类。
FieldDropdown 用于可修改的下拉菜单字段的类。
FieldImage 用于块上的图片的类。
FieldLabel 用于不可编辑、不可序列化的文本字段的类。
FieldLabelSerializable 用于不可修改且可序列化的文本字段的类。
FieldNumber 用于可编辑数字字段的类。
FieldTextInput 用于可编辑文本字段的类。
FieldVariable 用于变量的下拉菜单字段的类。
FlyoutButton 用于浮出控件中的按钮或标签的类。
FlyoutMetricsManager 计算飞出工作区的指标。这些指标主要用于调整浮出控件的滚动条大小。
手势 用于一个手势的类。
网格 用于工作区网格的类。
HorizontalFlyout 针对浮出操作的类。
输入 用于包含可选字段的输入的类。
InsertionMarkerManager 用于控制拖动期间连接的更新的类。它主要负责查找最接近的有效连接,并在拖动期间根据需要突出显示或取消突出显示该连接。
InsertionMarkerPreviewer
Marker 标记的类。此字段在键盘导航中用于在 Blockly AST 中保存位置。
MarkerManager 此类用于管理工作区上的多个标记和光标。
菜单 基本菜单类。
MenuItem 表示菜单中的项目的类。
MetricsManager 负责计算所有工作区指标的管理器。
名称 用于实体名称(变量、过程等)数据库的类。
选项 在行为未指定的情况下,使用合理的默认值解析用户指定的选项。
RenderedConnection 用于连接屏幕上可渲染的块的类。
滚动条 用于纯 SVG 滚动条的类。此方法提供的滚动条可以保证运行,但外观或行为可能与系统的滚动条不同。
ScrollbarPair 用于一对滚动条的类。水平和垂直。
ShortcutRegistry 用于键盘快捷键注册表的类。这将是一个单例。您不应创建新实例,而应仅从 ShortcutRegistry.registry 访问此类。
TabNavigateCursor 用于在标签页的可导航字段之间导航的光标。
主题 用于主题的类。
ThemeManager 用于存储和更新工作区主题及界面组件的类。
工具箱 用于工具箱的类。创建工具箱的 DOM。
ToolboxCategory 用于工具箱中某个类别的类。
ToolboxItem 用于工具箱中商品的类。
ToolboxSeparator 用于工具箱分隔符的类。这是工具箱上显示的细线。此商品无法互动。
回收站 垃圾桶的课程。
UnattachedFieldError 表示错误,字段在实际附加到所述块之前,尝试访问其块或有关其块的信息。
VariableMap 用于变量映射的类。它包含一个字典数据结构,其中变量类型为键,变量列表为值。变量列表就是键指示的类型。
VariableModel 用于变量模型的类。保存变量的相关信息,包括名称、ID 和类型。
VerticalFlyout 针对浮出操作的类。
Google Workspace 用于工作区的类。这是一个包含块的数据结构。没有界面,可以无头创建。
WorkspaceAudio 用于为工作区加载、存储和播放音频的类。
WorkspaceDragger 用于工作区拖动器的类。在用户通过鼠标或触摸拖动工作区时,可随意移动工作区。
WorkspaceSvg 用于工作区的类。屏幕上的这个区域包含可选的垃圾桶、滚动条、气泡和拖动功能。
ZoomControls 用于缩放控件的类。

抽象类

抽象类 说明
字段 可编辑字段的抽象类。
飞出 针对浮出操作的类。

枚举

Enumeration 说明
ConnectionType 连接或输入类型的枚举。

Functions

函数 说明
hasBubble(obj) 用于检查给定对象是否为 IHasBubble 的类型保护程序。
hideChaff(opt_onlyClosePopups) 关闭提示、上下文菜单、下拉菜单选项等。
inject(container, opt_options) 将 Blockly 编辑器注入指定的容器元素(通常为 div)。
isCopyable(obj)
isDeletable(obj) 返回指定对象是否可为 ID 返回。
isDraggable(obj) 返回指定对象是否为 IDraggable。
isIcon(obj) 类型保护程序,用于检查给定对象是否为 IIcon。
isPaster(obj)
isSelectable(obj) 检查给定对象是否为 ISelectable。
isSerializable(obj) 类型保护程序,用于检查给定对象是否为 ISerializable。
isVariableBackedParameterModel(param) 返回指定对象是否为变量容器。
setLocale(locale)

将语言区域(即本地化消息/块文字等)设为指定语言区域。

从脚本标记加载时,这没有用//没有必要,因为消息会自动插入 Blockly.Msg 对象中。但是,我们同时在脚本标记和非脚本标记环境中提供该标记,以便编译器可以正确创建我们的类型定义文件。

接口

接口 说明
BlocklyOptions Blockly 选项。
FieldCheckboxConfig 复选框字段的配置选项。
FieldCheckboxFromJsonConfig fromJson 配置选项
FieldConfig 基本字段的额外配置选项。
FieldDropdownFromJsonConfig fromJson 配置
FieldImageConfig 映像字段的配置选项。
FieldImageFromJsonConfig fromJson 配置选项
FieldLabelConfig 标签字段的配置选项。
FieldLabelFromJsonConfig 标签字段的 fromJson 配置选项。
FieldNumberConfig 数字字段的配置选项。
FieldNumberFromJsonConfig fromJson 配置选项
FieldTextInputFromJsonConfig 文本输入字段的 fromJson 配置选项。
FieldVariableConfig 变量字段的配置选项。
FieldVariableFromJsonConfig fromJson 配置选项
IASTNodeLocation AST 节点位置接口。
IASTNodeLocationSvg AST 节点位置 SVG 接口。
IASTNodeLocationWithBlock 具有关联块的 AST 节点位置。
IAutoHideable 可自动隐藏的组件的界面。
IBoundedElement 有边界的元素接口。
IBubble 气泡界面。
ICollapsibleToolboxItem 工具箱中可收起的项的界面。
IComponent 可向 ComponentManager 注册的工作区组件的界面。
IConnectionChecker 用于连接类型检查逻辑的类。
IConnectionPreviewer 显示某个块在放置后其连接位置的直观“预览”。
IContextMenu
ICopyable
IDeletable 可以删除的对象的接口。
IDeleteArea 组件的界面,该组件可以删除放在其上的方块或气泡。
IDraggable 表示可以拖动的对象。
IDragger
IDragStrategy
IDragTarget 当某个块或气泡在其上面或上方拖动时,具有自定义行为的组件的界面。
IFlyout 浮出控件的界面。
IHasBubble
IIcon
IKeyboardAccessible 用于处理键盘快捷键的对象的接口。
IMetricsManager 指标管理器的界面。
IMovable 可移动对象的接口。
IPaster 可将数据粘贴到工作区的对象。
IPositionable 位于工作区顶部的组件的界面。
IRegistrable 可注册的 Blockly 组件的界面。
ISelectable 可选择的对象的接口。
ISelectableToolboxItem 工具箱中可选择的项的界面。
ISerializable
IStyleable 可添加样式的对象的接口。
IToolbox 工具箱的界面。
IToolboxItem 工具箱中某项内容的界面。
IVariableBackedParameterModel 用于保存变量模型的参数模型的接口。

命名空间

命名空间 说明
ASTNode
屏蔽
blockAnimations
blockRendering
browserEvents
对话泡
bumpObjects
剪贴板
CollapsibleToolboxCategory
评论
common
ComponentManager
constants
ContextMenu
ContextMenuItems
ContextMenuRegistry
CSS
对话框
拖动
事件
扩展功能
fieldRegistry
Geras
图标
ICopyable
输入
InsertionMarkerManager
libraryBlocks
MetricsManager
名称
选项
流程
registry
RenderedConnection
renderManagement
序列化
ShortcutItems
ShortcutRegistry
主题
ThemeManager
主题
thrasos
ToolboxCategory
ToolboxSeparator
提示
轻触
uiPosition
utils
变量
VariablesDynamic
WidgetDiv
XML
zelos

变量

变量 说明
屏蔽设置 块类型名称到块原型对象的映射。
COLLAPSE_CHARS
COLLAPSED_FIELD_NAME
COLLAPSED_INPUT_NAME
配置 该对象包含 Blockly 上我们希望开发者能够更改的所有值。
defineBlocksWithJsonArray 从一系列 JSON 块定义中定义块,可能由 Blockly 开发者工具生成。
DELETE_VARIABLE_ID
DropDownDiv
getMainWorkspace 返回主工作区。返回上次使用的主工作区(基于焦点)。请勿使用此功能,尤其是当网页上有多个 Blockly 实例时。
getSelected 返回当前选定的可复制对象。
INPUT_VALUE
JavaScript
消息 本地化消息字典。
NEXT_STATEMENT
OPPOSITE_TYPE
OUTPUT_VALUE
PREVIOUS_STATEMENT
PROCEDURE_CATEGORY_NAME 用于在工具箱 XML 中某个类别的“custom”属性的字符串。此字符串指示应用过程块动态填充类别。
RENAME_VARIABLE_ID
setParentContainer 设置父级容器。这是首次调用 Blockly.inject 时 WidgetDiv、dropDownDiv 和 Prompt 会呈现到的容器元素。如果在第一个 Blockly.inject 之后调用,则此方法为 NOP。
svgResize 调整 SVG 图片的大小,使其完全填满容器。在视图实际更改大小(例如,调整窗口大小/设备屏幕方向改变时)时调用此方法。若要在内容发生变化时(例如添加或移除块时)调整工作区大小,请参阅 workspace.resizeContents。记录 SVG 图片的高度/宽度。
TOOLBOX_AT_BOTTOM
TOOLBOX_AT_LEFT
TOOLBOX_AT_RIGHT
TOOLBOX_AT_TOP
VARIABLE_CATEGORY_NAME 用于在工具箱 XML 中某个类别的“custom”属性的字符串。此字符串表示该类别应使用变量块动态填充。
VARIABLE_DYNAMIC_CATEGORY_NAME 用于在工具箱 XML 中某个类别的“custom”属性的字符串。此字符串表示该类别应使用变量块动态填充。
版本 块核心版本。此常量会被构建脚本 (npm run build) 替换成 package.json 中的版本值。此操作由 Closure 编译器在 buildCompressed gulp 任务中完成。对于本地 build,您可以将 --define='Blockly.VERSION=X.Y.Z' 传递给编译器,以替换此常量。

类型别名

类型别名 说明
FieldCheckboxValidator 为在设置字段值之前验证其值更改而调用的函数。
FieldDropdownConfig 下拉菜单字段的配置选项。
FieldDropdownValidator 为在设置字段值之前验证其值更改而调用的函数。
FieldNumberValidator 为在设置字段值之前验证其值更改而调用的函数。
FieldTextInputConfig 文本输入字段的配置选项。
FieldTextInputValidator 为在设置字段值之前验证其值更改而调用的函数。
FieldValidator 为在设置字段值之前验证其值更改而调用的函数。
FieldVariableValidator 为在设置字段值之前验证其值更改而调用的函数。
ICopyData
MenuGenerator 菜单选项数组,或为 FieldDropdown 或其后代生成菜单选项数组的函数。
MenuGeneratorFunction 一个函数,用于为 FieldDropdown 或其后代生成菜单选项数组。
MenuOption 下拉菜单中的单个选项。第一个元素是人类可读的值(文本或图片),第二个元素是中性值。