ブロッククラス
1 つのブロックのクラス。通常は直接呼び出さず、workspace.newBlock() を使用することをおすすめします。
署名:
export declare class Block
コンストラクタ
| コンストラクタ | 修飾子 | 説明 |
|---|---|---|
| (constructor)(workspace, prototypeName, opt_id) | Block クラスの新しいインスタンスを作成します。 |
プロパティ
| プロパティ | 修飾子 | タイプ | 説明 |
|---|---|---|---|
| childBlocks_ | protected |
this[] | |
| collapsed_ | protected |
ブール値 | |
| COLLAPSED_FIELD_NAME |
|
文字列 | 折りたたまれたフィールドに指定された言語に依存しない ID。 |
| COLLAPSED_INPUT_NAME |
|
文字列 | 折りたたまれた入力に指定された言語に依存しない ID。 |
| colour_ | protected |
文字列 | ブロックの色（#RRGGBB 形式）。 |
| compose? | (rootBlock: Block) => void | （省略可）ミュータ ダイアログの内容に基づいてブロックを再構成するオプションのメソッド。 | |
| contextMenu | ブール値 | ||
| data | string | null | ブロックと XML 間でラウンドトリップするオプションのテキストデータ。効果なしサードパーティがメタ情報として使用する場合がある。 | |
| 分解する | （workspace: Workspace）=> ブロック | （省略可）このブロックの構成を表すブロックをミュータタ フライアウトに入力するオプションの関数。 | |
| 破棄しますか？ | () => void | （省略可）破棄時に呼び出されるオプションのメソッド。 | |
| disposing | protected |
ブール値 | 現在のブロックは現在破棄中ですか？ |
| domToMutation? | (p1: Element) => void | （省略可）XML からミューテーション状態を逆シリアル化する方法を定義するオプションの逆シリアル化メソッド。これは mutationToDom の定義と組み合わせる必要があります。 |
|
| getDeveloperVariables? | () => string[] | （省略可）ジェネレータで使用されるデベロッパー変数を宣言するオプションのメソッド。デベロッパー変数はユーザーには表示されませんが、生成されたコードではグローバル変数として宣言されます。 | |
| 帽子 | 文字列 | （省略可）帽子の種類の名前。 | |
| helpUrl | string | (() => string) | null | ブロックのヘルプ用の文字列、または URL を返す関数。ヘルプが不要な場合は null にします。 | |
| アイコン | IIcon[] | ||
| id | 文字列 | ||
| init? | () => void | （省略可）初期化中に呼び出されるオプションのメソッド。 | |
| inputList | 入力[] | ||
| inputsInline? | ブール値 | （省略可） | |
| inputsInlineDefault? | ブール値 | （省略可） | |
| isInFlyout | ブール値 | ||
| isInMutator | ブール値 | ||
| isInsertionMarker_ | protected |
ブール値 | このブロックが挿入マーカーである場合は true。 |
| loadExtraState? | (p1: any) => void | （省略可）ブロックの追加状態（ミューテーション状態など）を JSON 互換のものから逆シリアル化する方法を定義するオプションのシリアル化方法。これは saveExtraState の定義と組み合わせる必要があります。 |
|
| mutationToDom? | (...p1: any[]) => Element | （省略可）ミューテーション ステートを XML にシリアル化する方法を定義するオプションのシリアル化メソッド。これは domToMutation の定義と組み合わせる必要があります。 |
|
| nextConnection | 接続 | null | ||
| onchange? | ((p1: Abstract) => void) | null | （省略可）ブロックの親ワークスペースが変更されるたびに使用するコールバック メソッド。通常、これはコンストラクタ、ブロック型イニシャライザ関数、拡張機能イニシャライザ関数からのみ呼び出されます。 | |
| outputConnection | 接続 | null | ||
| outputShape_ | protected |
number | null | |
| parentBlock_ | protected |
this | null | |
| previousConnection | 接続 | null | ||
| レンダリング済み | readonly |
ブール値 | このブロックは BlockSVG ですか？ |
| RTL | ブール値 | ||
| saveExtraState? | (doFullSerialization?: boolean) => any | （省略可）ブロックの追加状態（ミューテーション状態など）を JSON 互換の形式にシリアル化する方法を定義するオプションのシリアル化メソッド。これは loadExtraState の定義と組み合わせる必要があります。 |
|
| styleName_ | protected |
文字列 | ブロックスタイルの名前。 |
| suppressPrefixSuffix | boolean | null | 生成されたコードに STATEMENT_PREFIX と STATEMENT_SUFFIX を追加しないようにする省略可能なプロパティ。 | |
| ツールチップ | Tooltip.TipInfo | ||
| type | 文字列 | ||
| workspace | Google Workspace |
メソッド
| メソッド | 修飾子 | 説明 |
|---|---|---|
| addIcon(icon) | 指定されたアイコンをブロックに追加します。 | |
| allInputsFilled(opt_shadowBlocksAreFilled) | すべてのステートメントと値の入力がブロックで埋められているかどうかを再帰的にチェックします。このスタック内の後続のすべてのステートメント ブロックもチェックします。 | |
| appendDummyInput(name) | ダミー入力行を追加します。 | |
| appendEndRowInput(name) | 行を終了する入力を追加します。 | |
| appendInput(input) | 指定された入力行を追加します。 ブロックにカスタム入力を追加できます。 |
|
| appendStatementInput(name) | ステートメント入力行を追加します。 | |
| appendValueInput(name) | 値入力行を追加します。 | |
| bumpNeighbours() | 接続されていないブロックをずらす。実際には接続されていない 2 つのブロックが、偶然にも画面上で並ぶことがないようにします。 | |
| dispose(healStack) | このブロックを破棄します。 | |
| disposeInternal() | protected |
最上位のブロックで必要な処理を行わずに、このブロックを破棄します。たとえば、イベントが発生しない、ブロックのプラグを抜くなど。 |
| doInit_() | protected |
init() 関数を呼び出し、関連するイベントの発生などを処理します。 |
| getChildren(ordered) | このブロックに直接ネストされているすべてのブロックを検索します。値とステートメントの入力、および後続のステートメントが含まれます。出力タブの接続や、それより前のステートメントは除外されます。ブロックは、必要に応じて上から下に位置で並べ替えられます。 | |
| getColour() | ブロックの色を取得します。 | |
| getCommentText() | このブロックのコメントを返します（コメントがない場合、null を返します）。 | |
| getDescendants(ordered) | このブロック内に直接または間接的にネストされているすべてのブロックを検索します。このブロックをリストに含めます。値とステートメントの入力、および後続のステートメントが含まれます。出力タブの接続や、それより前のステートメントは除外されます。ブロックは、必要に応じて上から下に位置で並べ替えられます。 | |
| getDisabledReasons() | ブロックが現在無効になっている理由を取得します（該当する場合）。ブロックが有効になっている場合、このセットは空になります。 | |
| getField(name) | ブロックから名前付きフィールドを返します。 | |
| getFields() | ブロック上のすべてのフィールドを提供するジェネレータを返します。 ブロックのフィールドを反復処理するために使用できるジェネレータ。 |
|
| getFieldValue(name) | 指定されたフィールドの言語に依存しない値を返します。 | |
| getHue() | ブロックの HSV 色相値を取得します。色相が設定されていない場合は null。 | |
| getIcon(type) | ||
| getIcons() | ||
| getInheritedDisabled() | 保護者によるブロックが有効かどうかを取得します。ブロック独自の disabled プロパティは考慮されません。 | |
| getInput(name) | 名前付き入力オブジェクトを取得します。 | |
| getInputsInline() | 値入力が水平方向または垂直方向に配置されているかどうかを取得します。 | |
| getInputTargetBlock(name) | 名前付き入力に接続されているブロックを取得します。 | |
| getInputWithBlock(block) | 指定されたブロックに接続する入力を返します。 | |
| getNextBlock() | このブロックに直接接続されている次のステートメント ブロックを返します。 | |
| getOutputShape() | ブロックの出力シェイプを取得します。 | |
| getParent() | 親ブロックを返します。このブロックが最上位レベルにある場合は null を返します。親ブロックは、前の接続に接続されているブロック（ステートメント ブロックの場合）または出力接続に接続されているブロック（値ブロックの場合）です。 | |
| getPreviousBlock() | 前の接続に接続されているブロックを返します。 | |
| getRelativeToSurfaceXY() | 描画サーフェスの原点（0,0）を基準とした、このブロックの左上隅の座標をワークスペース単位で返します。 | |
| getRootBlock() | このブロックのツリー内の最上位のブロックを返します。このブロックが最上位レベルにある場合は、ブロック自体が返されます。 | |
| getStyleName() | ブロックスタイルの名前を取得します。 | |
| getSurroundParent() | 現在のブロックを囲む親ブロックを返します。このブロックを囲むブロックがない場合は null を返します。親ブロックは前のステートメントにすぎませんが、囲むブロックは if ステートメントや while ループなどです。 | |
| getTooltip() | このブロックのツールチップ テキストを返します。 | |
| getVars() | このブロックで参照されているすべての変数を返します。 | |
| hasDisabledReason(reason) | 指定された理由でブロックが現在無効になっているかどうかを取得します。 | |
| hasIcon(type) | ||
| initModel() | ブロックのすべてのフィールドで initModel を呼び出します。複数回呼び出される場合があります。initModel または initSvg は、ブロックの作成後に、ブロックとの最初の操作の前に呼び出す必要があります。インタラクションには、UI アクション（クリック、ドラッグなど）とイベントの発生（作成、削除、変更など）が含まれます。 | |
| isCollapsed() | ブロックが閉じられているかどうかを取得します。 | |
| isDeletable() | このブロックを削除できるかどうかを取得します。 | |
| isDisposed() | このブロックが破棄または削除されたかどうかを返します。 | |
| isDuplicatable() | ブロックが複製可能かどうかを取得します。このブロックとその子孫を複製すると、このブロックがワークスペースの容量を超える場合、このブロックは複製できません。このブロックとその子孫を複製すると、いずれかのタイプが maxInstances を超える場合、このブロックは複製できません。 | |
| isEnabled() | このブロックが有効かどうかを取得します。ブロックが無効になる理由がない場合は、ブロックが有効と見なされます。ブロックが無効な場所にある場合など、ユーザーが手動で有効にしようとしたとしても、他の理由でブロックが無効になっていることがあります。 | |
| isInsertionMarker() | このブロックが挿入マーカー ブロックかどうかを取得します。 | |
| isOwnDeletable() | このブロック独自の削除可能プロパティが true か false かを返します。 | |
| isOwnEditable() | このブロック独自の編集可能プロパティが true か false かを返します。 | |
| isShadow() | このブロックがシャドウ ブロックかどうかを取得します。 | |
| jsonInit(json) | クロスプラットフォームで国際化に適した JSON 記述を使用して、このブロックを初期化します。 | |
| mixin(mixinObj, opt_disableCheck) | mixinObj の Key-Value をこのブロック オブジェクトに追加します。デフォルトでは、このメソッドは、mixinObj のキーがプロトタイプ値を含むブロック内の既存の値を上書きしないようにします。これにより、今後のブロック機能とのミキシン / 拡張機能の非互換性に対する保険が提供されます。このチェックは、2 番目の引数として 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) | このブロックを削除可能にするかどうかを設定します。 | |
| setDisabledReason(disabled, reason) | ブロックが無効になる可能性がある理由を追加または削除します。ブロックを無効にする理由がある場合、そのブロック自体は無効と見なされます。ブロックは、ユーザーが手動で無効にしたときや、ブロックが無効な場合など、複数の独立した理由で同時に無効になることがあります。 | |
| setEditable(editable) | このブロックを編集可能にするかどうかを設定します。 | |
| setFieldValue(newValue, name) | このブロックの指定されたフィールドの値を設定します。 | |
| setHelpUrl(url) | このブロックのヘルプページの 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) | このブロックをその上位ブロックから外します。このブロックがステートメントの場合は、必要に応じて下のブロックを上のブロックに再接続します。 |