blockly > 屏蔽

屏蔽课程

用于一个块的类。通常不会直接调用,建议使用 workspace.newBlock()。

Signature:

export declare class Block implements IASTNodeLocation, IDeletable 

实现IASTNodeLocationIDeletable

构造函数

构造函数 修饰符 说明
(constructor)(workspace, protoName, opt_id) 构造 Block 类的新实例

属性

媒体资源 修饰符 类型 说明
childBlocks_ protected 此 []
collapsed_ protected boolean
COLLAPSED_FIELD_NAME

static

readonly

string 为收起状态的字段提供的中性语言 ID。
COLLAPSED_INPUT_NAME

static

readonly

string 为收起后的输入内容提供的语言中性 ID。
colour_ protected string 块的颜色,采用“#RRGGBB”格式。
compose? (p1:)=> 无效 (可选)可选函数,用于根据更改器对话框的内容重新配置代码块。
contextMenu boolean
数据 字符串 | null 在块和 XML 之间往返的可选文本数据。没有任何影响。第三方可使用此属性提供元信息。
如何分解? (p1:工作区) => 屏蔽 (可选)可选函数,会使用此代码块的组件填充更改器的对话框。
destroy? () => 空 (可选)在处理过程中调用的可选方法。
domToMutation? (p1:元素)=> void (可选)可选的反序列化方法,用于定义如何从 XML 对变更状态进行反序列化。它必须与定义 mutationToDom 相结合。
getDeveloperVariables? () => 字符串 [] (可选)用于声明开发者变量的可选属性。返回供生成器使用的变量名称列表。开发者变量绝不会向用户显示,但会在生成的代码中声明为全局变量。
帽子? string (可选)帽子类型的名称。
helpUrl string | Function | null 用于获取块帮助的字符串或返回网址的函数。Null 表示无帮助。
图标 IIcon[]
ID [id] string
init? () => 空 (可选)在初始化期间调用的可选方法。
inputList 输入 []
inputsInline? boolean (可选)
inputsInlineDefault? boolean (可选)
isInFlyout boolean
isInMutator boolean
isInsertionMarker_ protected boolean 如果此块是插入标记,则为 true。
loadExtraState? (p1:任何)=> 无效 (可选)可选的序列化方法,用于定义如何从与 JSON 兼容的内容中反序列化块的额外状态(例如变更状态)。它必须与定义 saveExtraState 相结合。
mutateToDom? (...p1: any[]) => 元素 (可选)可选的序列化方法,用于定义如何将变更状态序列化为 XML。它必须与定义 domToMutation 相结合。
nextConnection 连接 | null
onchange ((p1: Abstract) => void) | null (可选)每当块的父工作区发生更改时使用的可选回调方法。这通常只从构造函数、块类型初始化程序函数或扩展初始化程序函数调用。
outputConnection 连接 | null
outputShape_ protected 数字 | null
parentBlock_ protected 此 | null
previousConnection 连接 | null
已呈现 boolean | null
RTL boolean
saveExtraState? (doFullSerialization?: 布尔值) => 任意 (可选)可选的序列化方法,用于定义如何将块的额外状态(例如变更状态)序列化为与 JSON 兼容的某种状态。它必须与定义 loadExtraState 相结合。
styleName_ protected string 块样式的名称。
suppressPrefixSuffix boolean | null 一个可选属性,用于禁止向生成的代码添加 STATEMENT_PREFIX 和 STATEMENT_SUFFIX。
提示 Tooltip.TipInfo
type string
工作区 Google Workspace

方法

方法 修饰符 说明
addIcon(icon) 向砌块添加指定图标。
allInputsFilled(opt_shadowBlocksAreFilled) 以递归方式检查是否所有语句和值输入都填充了块。此外,还要检查此堆栈中的以下所有语句块。
appendDummyInput(name) 附加一个虚拟输入行。
appendEndRowInput(name) 用于附加结束行的输入。
appendInput(input)

用于附加指定的输入行。

允许将自定义输入附加到代码块。

appendStatementInput(name) 附加语句输入行。
appendValueInput(name) 向输入行附加一个值。
bumpNeighbours() 碰撞未连接的块,使其不一致。实际上并未连接的两个方块在屏幕上不应恰好排成一行。
dispose(healStack) 处置此块。
disposeInternal() protected 处理此代码块,而不执行 Top 代码块所需的操作。例如,没有触发事件、拔下代码块等。
doInit_() protected 调用 init() 函数并处理相关的事件触发等。
getChildren(ordered) 查找直接嵌套在此代码块中的所有代码块。包括价值和语句输入,以及任何后续语句。排除输出标签页或前面的任何语句中的任何连接。组成要素有选择性地按位置排序;从上到下排序。
getColour() 获取方块的颜色。
getCommentText() 返回此块的注释(如果没有注释,则返回 null)。
getDescendants(ordered) 查找直接或间接嵌套在此代码块中的所有代码块。在列表中包含此屏蔽设置。包括价值和语句输入,以及以下任何语句。排除输出标签页上的任何连接或上述任何语句。组成要素有选择性地按位置排序;从上到下排序。
getField(name) 返回块中的已命名字段。
getFieldValue(name) 返回指定字段的语言中性值。
getHue() 获取块的 HSV 色调值。如果未设置色调,则为 Null。
getIcon(type)
getIcons()
getInheritedDisabled() 获取屏蔽操作是否因为父级而遭到停用。而不会考虑该屏蔽设置本身的已停用属性。
getInput(name) 获取已命名的输入对象。
getInputsInline() 获取值输入是水平排列还是垂直排列。
getInputTargetBlock(name) 获取附加到指定输入的块。
getInputWithBlock(block) 返回连接到指定块的输入。
getNextBlock() 返回直接连接到此代码块的下一个语句代码块。
getOutputShape() 获取块的输出形状。
getParent() 返回父块,如果该块位于顶层,则返回 null。父块是连接到上一个连接的块(对于语句块)或连接到输出连接的块(对于值块)。
getPreviousBlock() 返回连接到上一个连接的块。
getRelativeToSurfaceXY() 返回此图块左上角相对于绘图表面原点 (0,0) 的坐标,以工作区单位为单位。
getRootBlock() 返回该代码块树中最顶层的代码块。如果此代码块位于顶级,它将自行返回。
getStyleName() 获取块样式的名称。
getSurroundParent() Return the parent block that surrounds the current block, or null if this block has no surrounding block. 父代码块可能只是前一个语句,而周围的语句是 if 语句、while 循环等。
getTooltip() 返回此块的提示文本。
getVars() 返回此代码块引用的所有变量。
hasIcon(type)
initModel() 对块上的所有字段调用 initModel。可以多次调用。必须在创建块之后、首次与其交互之前调用 initModel 或 initSvg。交互包括界面操作(例如点击和拖动)和触发事件(例如创建、删除和更改)。
isCollapsed() 获取该代码块是否已收起。
isDeletable() 获取此块是否可删除。
isDisposed() 返回相应块是否已处置 / 删除。
isDuplicatable() 获取块是否可复制。如果复制此块及其后代,则会将此块置于工作区的容量上方,则此块是不可复制的。如果复制此块及其后代会将任何类型置于其 maxInstance 上,则此块是不可复制的。
isEnabled() 获取此屏蔽设置是否已启用。
isInsertionMarker() 获取此块是否为插入标记块。
isOwnDeletable() 返回该块自己的可删除属性为 true 还是 false。
isOwnEditable() 返回该代码块自己的可修改属性是 true 还是 false。
isShadow() 获取此块是否为影子块。
jsonInit(json) 使用支持国际化的跨平台 JSON 说明初始化此块。
mixin(mixinObj, opt_disableCheck) 将 mixinObj 中的键/值添加到这个 block 对象。默认情况下,此方法将检查 mixinObj 中的键是否不会覆盖块中的现有值,包括原型值。这样可以防止混淆 / 扩展与未来的块功能不兼容。可通过传递 true 作为第二个参数来停用此检查。
moveBy(dx, dy, reason) 以相对偏移量移动块。
moveInputBefore(name, refName) 将已命名的输入内容移至此块上的其他位置。
moveNumberedInputBefore(inputIndex, refIndex) 将带编号的输入内容移至此块上的其他位置。
removeIcon(type) 从代码块中移除 getType 与指定类型 iconType 匹配的图标。
removeInput(name, opt_quiet) 从此代码块中移除输入。
renameVarById(oldId, newId) 关于变量正在重命名的通知。如果 ID 与此代码块的某个变量匹配,请将其重命名。
setCollapsed(collapsed) 设置是否收起该块。
setColour(colour) 更改方块的颜色。
setCommentText(text) 设置此块的评论文本。
setDeletable(deletable) 设置此块是否可删除。
setEditable(editable) 设置此组成要素是否可修改。
setEnabled(enabled) 设置是否启用屏蔽设置。
setFieldValue(newValue, name) 设置此块的指定字段的值。
setHelpUrl(url) 设置此版块的帮助页面的网址。
setInputsInline(newBoolean) 设置值输入是水平排列还是垂直排列。
setMovable(movable) 设置此砌块是否可移动。
setMutator(_mutator) 为此块提供一个更改器对话框。
setNextStatement(newBoolean, opt_check) 设置是否可以将另一个方块连结到此方块的底部。
setOnChange(onchangeFn) 设置在块的父级工作区发生更改时使用的回调函数,用于替换之前的所有 onchange 处理程序。这通常只从构造函数、块类型初始化程序函数或扩展初始化程序函数调用。
setOutput(newBoolean, opt_check) 设置此块是否返回值。
setOutputShape(outputShape) 设置块的输出形状。
setPreviousStatement(newBoolean, opt_check) 设置此版块是否可以链接至其他版块的底部。
setStyle(blockStyleName) 设置方块的样式和颜色值。
setTooltip(newTip) 设置此块的提示。
setWarningText(_text, _opt_id) 设置此块的警告文本。
toDevString()

此方法返回一个以开发者术语描述该区块的字符串(类型名称和 ID,仅限英语)。

旨在用于控制台日志和错误。如果您需要使用用户母语的字符串(包括块文本、字段值和子块),请使用 [toString()]

toString(opt_maxLength, opt_emptyToken) 针对此代码块及任何子项创建人类可读的文本表示形式。
unplug(opt_healStack) 从上层方块上拔下这个方块。如果此代码块是一个语句,可以选择将下面的代码块与顶部的代码块重新连接。