Block クラス
1 つのブロックのクラス。通常は直接呼び出されませんが、workspace.newBlock() をおすすめします。
署名:
export declare class Block implements IASTNodeLocation
実装: IASTNodeLocation
コンストラクタ
| コンストラクタ | 修飾子 | 説明 |
|---|---|---|
| （コンストラクタ）(workspace, プロトタイプ名、opt_id) | Block クラスの新しいインスタンスを作成します。 |
プロパティ
| プロパティ | 修飾子 | タイプ | 説明 |
|---|---|---|---|
| childBlocks_ | protected |
この [] | |
| collapsed_ | protected |
boolean | |
| COLLAPSED_FIELD_NAME |
|
string | 折りたたまれたフィールドに付与する言語中立の ID。 |
| COLLAPSED_INPUT_NAME |
|
string | 折りたたまれた入力に割り当てられる言語中立の ID。 |
| colour_ | protected |
string | ブロックの色（「#RRGGBB」形式）。 |
| compose? | (p1: ブロック) => void | （省略可）ミューテータ ダイアログの内容に基づいてブロックを再構成するオプションの関数。 | |
| contextMenu | boolean | ||
| データ | 文字列 | null | ブロックと XML の間で往復するテキストデータ（省略可）。効果なしサードパーティがメタ情報に使用できる。 | |
| どうすればよいでしょうか。 | （p1: ワークスペース）=> [ブロック] | （省略可）ミューテータのダイアログにこのブロックのコンポーネントを挿入するオプションの関数。 | |
| destroy? | () => void 型 | （省略可）廃棄時に呼び出されるオプションのメソッド。 | |
| 破棄 | protected |
boolean | 現在のブロックは破棄の処理中ですか？ |
| （p1：要素）=> void | （省略可）XML からミューテーションの状態を逆シリアル化する方法を定義するためのシリアル化解除メソッド（オプション）。これは、mutationToDom の定義と組み合わせる必要があります。 |
||
| getDeveloperVariables? | () => 文字列 [] | （省略可）デベロッパー変数を宣言するためのプロパティ（省略可）。ジェネレータで使用する変数名のリストを返します。デベロッパー変数はユーザーには表示されませんが、生成されたコードでグローバル変数として宣言されます。 | |
| 帽子？ | string | （省略可）帽子の種類の名前。 | |
| helpUrl | string | Function | null | ブロックヘルプの文字列、または URL を返す関数。ヘルプがない場合は null。 | |
| アイコン | IIcon[] | ||
| id | string | ||
| init? | () => void 型 | （省略可）初期化中に呼び出されるオプションのメソッド。 | |
| inputList | 入力[] | ||
| inputsInline | boolean | （省略可） | |
| inputsInlineDefault？ | boolean | （省略可） | |
| isInFlyout | boolean | ||
| isInMutator | boolean | ||
| isInsertionMarker_ | protected |
boolean | このブロックが挿入マーカーの場合は true。 |
| loadExtraState | (p1: any) => void 型 | （省略可）JSON と互換性のある要素からブロックの追加状態（ミューテーション状態など）を逆シリアル化する方法を定義するシリアル化メソッド（オプション）。これは、saveExtraState の定義と組み合わせる必要があります。 |
|
| ミューテーションタスク | (...p1: any[]) => 要素 | （省略可）ミューテーション状態を XML にシリアル化する方法を定義するためのシリアル化メソッド（省略可）。これは、domToMutation の定義と組み合わせる必要があります。 |
|
| nextConnection | 接続 | null | ||
| どうでしょうか。 | ((p1: Abstract) => void) | null | （省略可）ブロックの親ワークスペースが変更されたときに使用するオプションのコールバック メソッド。通常、これはコンストラクタ、ブロック型初期化関数、拡張機能初期化関数のいずれかからのみ呼び出されます。 | |
| outputConnection | 接続 | null | ||
| outputShape_ | protected |
数値 | null | |
| parentBlock_ | protected |
これ | null | |
| previousConnection | 接続 | null | ||
| レンダリングされた | readonly |
boolean | このブロックは BlockSVG ですか？ |
| RTL | boolean | ||
| saveExtraState? | (doFullSerialization?: boolean) => 任意 | （省略可）ブロックの追加状態（ミューテーション状態など）を JSON と互換性のあるものにシリアル化する方法を定義するシリアル化メソッド（省略可）。これは、loadExtraState の定義と組み合わせる必要があります。 |
|
| styleName_ | protected |
string | ブロック スタイルの名前。 |
| suppressPrefixSuffix | boolean | null | 生成されたコードへの STATEMENT_PREFIX と STATEMENT_SUFFIX の追加を抑制するためのプロパティ（省略可）。 | |
| ツールチップ | Tooltip.TipInfo | ||
| タイプ | string | ||
| ワークスペース | 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) | ブロックから名前付きフィールドを返します。 | |
| getFieldValue(name) | 指定したフィールドの言語に依存しない値を返します。 | |
| getHue() | ブロックの HSV 色相値を取得します。色相が設定されていない場合は null です。 | |
| getIcon(type) | ||
| getIcons() | ||
| getInheritedDisabled() | ブロックが親によって無効になっているかどうかを取得します。ブロック自体の無効なプロパティは考慮されません。 | |
| getInput(name) | 指定された入力オブジェクトを取得します。 | |
| getInputsInline() | 値の入力が水平方向または垂直方向のどちらに配置されているかを取得します。 | |
| getInputTargetBlock(name) | 指定された入力に関連付けられているブロックを取得します。 | |
| getInputWithBlock(block) | 指定したブロックに接続する入力を返します。 | |
| getNextBlock() | このブロックに直接接続されている次のステートメント ブロックを返します。 | |
| getOutputShape() | ブロックの出力シェイプを取得します。 | |
| getParent() | 親ブロックを返します。このブロックがトップレベルにある場合は null を返します。親ブロックは、前の接続に接続されているブロック（ステートメント ブロックの場合）または出力接続に接続されているブロック（value ブロックの場合）です。 | |
| 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() | このブロックで参照されるすべての変数を返します。 | |
| 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) | このブロックが編集可能かどうかを設定します。 | |
| setEnabled(enabled) | ||
| 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) | このブロックを上ブロックから外す。このブロックがステートメントの場合は、必要に応じて、下のブロックを一番上のブロックに再接続します。 |