Block クラス
1 つのブロックのクラス。通常は直接呼び出されないため、workspace.newBlock() の使用をおすすめします。
署名:
export declare class Block implements IASTNodeLocation, IDeletable
実装: IASTNodeLocation、IDeletable
コンストラクタ
| コンストラクタ | 修飾子 | 説明 |
|---|---|---|
| (structor)(workspace, protoName, 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 | （省略可）破棄時に呼び出されるオプションのメソッド。 | |
| domToMutation？ | （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 の定義と結び付ける必要があります。 |
|
| mutToDoTom？ | (...p1: any[]) => 要素 | （省略可）ミューテーション状態を XML にシリアル化する方法を定義するためのシリアル化メソッド（省略可）。これは domToMutation の定義と結び付ける必要があります。 |
|
| nextConnection | 接続 | null | ||
| どうでしょうか。 | ((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 | ||
| タイプ | string | ||
| workspace | Google Workspace |
Methods
| メソッド | 修飾子 | 説明 |
|---|---|---|
| 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) | このブロック内に直接的または間接的にネストされているすべてのブロックを見つけます。このブロックをリストに含めます。値とステートメントの入力、およびそれに続くステートメントが含まれます。出力タブや前の記述上のつながりは除外されます。ブロックは、必要に応じて上から下に位置順に並べ替えられます。 | |
| 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() | このブロックによって参照されるすべての変数を返します。 | |
| 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, 理由) | 相対オフセットでブロックを移動します。 | |
| moveInputBefore(name, refName) | 名前付き入力をこのブロックの別の場所に移動します。 | |
| moveNumberedInputBefore(inputIndex, refIndex) | 番号付きの入力をこのブロックの別の場所に移動します。 | |
| removeIcon(type) | getType が指定された type 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) | このブロックのヘルプページの 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) | このブロックと子を人が読める形式のテキスト表現を作成します。 | |
| unplugin(opt_healStack) | 上位のブロックからこのブロックを外してください。このブロックがステートメントの場合は、必要に応じて、下のブロックを一番上のブロックに再接続します。 |