blockly

blockly パッケージ

クラス

クラス 説明
ブロック 1 つのブロックのクラス。通常は直接呼び出されません。workspace.newBlock() を使用することをおすすめします。
BlockFlyoutInflater フライアウトのブロックの作成を担当するクラス。
BlockNavigationPolicy ブロックからのキーボード ナビゲーションを制御するルールのセット。
BlockSvg ブロックの SVG 表現のクラス。通常は直接呼び出されません。workspace.newBlock() を使用することをおすすめします。
ButtonFlyoutInflater フライアウトのボタンを作成するクラス。
CodeGenerator ブロックを言語に変換するコード ジェネレータのクラス。
CollapsibleToolboxCategory 折りたたみ可能なツールボックスのカテゴリのクラス。
ComponentManager ワークスペースに登録されているすべてのアイテムのマネージャー。
接続 ブロック間の接続のクラス。
ConnectionChecker 接続タイプのチェック ロジックのクラス。
ConnectionDB 接続のデータベース。接続は垂直コンポーネントの順に保存されます。これにより、バイナリ検索を使用して、エリア内の接続をすばやく検索できます。
ConnectionNavigationPolicy 接続からのキーボード ナビゲーションを制御するルールのセット。
ContextMenuRegistry コンテキスト メニュー項目の登録用のクラス。これはシングルトンとして使用することを想定しています。新しいインスタンスを作成するのではなく、ContextMenuRegistry.registry からのみこのクラスにアクセスする必要があります。
DeleteArea 上にドロップされたブロックまたはバブルを削除できるコンポーネントの抽象クラス。
DragTarget ブロックまたはバブルがドラッグされたり、その上にドロップされたりしたときにカスタム動作を行うコンポーネントの抽象クラス。
FieldCheckbox チェックボックス フィールドのクラス。
FieldDropdown 編集可能なドロップダウン フィールドのクラス。
FieldImage ブロック上の画像のクラス。
FieldLabel 編集不可でシリアル化不可のテキスト フィールドのクラス。
FieldLabelSerializable 編集不可能なシリアル化可能なテキスト フィールドのクラス。
FieldNavigationPolicy フィールドからのキーボード ナビゲーションを制御するルールのセット。
FieldNumber 編集可能な数値フィールドのクラス。
FieldTextInput 編集可能なテキスト フィールドのクラス。
FieldVariable 変数のプルダウン フィールドのクラス。
FlyoutButton フライアウトのボタンまたはラベルのクラス。
FlyoutButtonNavigationPolicy フライアウト ボタンからのキーボード ナビゲーションを制御するルールのセット。
FlyoutItem フライアウトに表示されるアイテムの表現。
FlyoutMetricsManager フライアウトのワークスペースの指標を計算します。指標は主に、フライアウトのスクロールバーのサイズ設定に使用されます。
FlyoutNavigationPolicy フライアウト内のアイテム間を移動する汎用ナビゲーション ポリシー。
FlyoutNavigator
FlyoutSeparator フライアウト内の要素間のギャップの表現。
FlyoutSeparatorNavigationPolicy フライアウト セパレータからのキーボード ナビゲーションを制御するルールのセット。フライアウト セパレータはナビゲートできないため、これは no-op プレースホルダです。
FocusableTreeTraverser 一般的なツリー トラバーサルをサポートする IFocusableTree 実装のヘルパー ユーティリティ。
FocusManager

1 つ以上の IFocusableTree 全体で Blockly のフォーカスを管理し、このフォーカスを DOM と双方向に同期する、ページごとのシングルトン。

ページ上の特定の Blockly コンポーネントの入力フォーカスを明示的に変更したい場合は、このマネージャーのフォーカス関数を使用する必要があります。

マネージャーは、DOM からのフォーカス イベント(ユーザーがページ要素をクリックしたときに発生する可能性があります)を処理し、対応する IFocusableNode が、focusNode() の呼び出しで表されるのと同じ方法で、アクティブまたはパッシブにハイライト表示されるようにします。

ジェスチャー 1 つのジェスチャーのクラス。
グリッド ワークスペースのグリッドのクラス。
HorizontalFlyout フライアウトのクラス。
入力 省略可能なフィールドを含む入力のクラス。
InsertionMarkerPreviewer
KeyboardNavigationController KeyboardNavigationController は、フルカーソルの可視化の有効/無効など、Blockly 全体のキーボード ナビゲーションの動作の調整を処理します。
LabelFlyoutInflater フライアウトのラベルの作成を担当するクラス。
LineCursor 線カーソルのクラス。
Marker マーカーのクラス。これは、キーボード ナビゲーションで Blockly AST の場所を保存するために使用されます。
MarkerManager ワークスペース上の複数のマーカーとカーソルを管理するクラス。
メニュー 基本的なメニュー クラス。
MenuItem メニュー内の項目を表すクラス。
MetricsManager すべてのワークスペース指標の計算のマネージャー。
名前 エンティティ名(変数、プロシージャなど)のデータベースのクラス。
Navigator キーボード ナビゲーション コマンドに応じてフォーカスを移動する場所を決定するクラス。
オプション ユーザー指定のオプションを解析し、動作が指定されていない場合は適切なデフォルトを使用します。
RenderedConnection 画面にレンダリングされる可能性のあるブロック間の接続のクラス。
スクロールバー 純粋な SVG スクロールバーのクラス。この手法では、動作が保証されたスクロールバーが提供されますが、システム スクロールバーの外観や動作とは異なる場合があります。
ScrollbarPair スクロールバーのペアのクラス。横向きと縦向き。
SeparatorFlyoutInflater フライアウトのセパレータの作成を担当するクラス。
ShortcutRegistry キーボード ショートカットのレジストリのクラス。これはシングルトンとして使用することを想定しています。新しいインスタンスを作成せず、ShortcutRegistry.registry からのみこのクラスにアクセスする必要があります。
テーマ テーマのクラス。
ThemeManager ワークスペースのテーマと UI コンポーネントを保存および更新するためのクラス。
Toast 一時的な通知の表示と消去を可能にするクラス。
ツールボックス ツールボックスのクラス。ツールボックスの DOM を作成します。
ToolboxCategory ツールボックス内のカテゴリのクラス。
ToolboxItem ツールボックス内のアイテムのクラス。
ToolboxSeparator ツールボックスの区切り文字のクラス。これは、ツールボックスに表示される細い視覚的な線です。このアイテムは操作できません。
ゴミ箱 ゴミ箱のクラス。
UnattachedFieldError フィールドがブロックに実際に接続される前に、そのブロックまたはブロックに関する情報にアクセスしようとしているエラーを表します。
VariableMap 変数マップのクラス。これには、変数型をキーとし、変数のリストを値とする辞書データ構造が含まれます。変数のリストは、キーで示される型です。
VariableModel 変数モデルのクラス。変数に関する情報(名前、ID、型など)を保持します。
VerticalFlyout フライアウトのクラス。
Google Workspace ワークスペースのクラス。これはブロックを含むデータ構造です。UI はなく、ヘッドレスで作成できます。
WorkspaceAudio ワークスペースの音声の読み込み、保存、再生を行うクラス。
WorkspaceDragger ワークスペース ドラッグのクラス。マウスまたはタップでドラッグすると、ワークスペースが移動します。
WorkspaceNavigationPolicy ワークスペースからのキーボード ナビゲーションを制御するルールのセット。
WorkspaceSvg ワークスペースのクラス。これは、ゴミ箱、スクロールバー、バブル、ドラッグを必要に応じて表示できる画面上の領域です。
ZoomControls ズーム コントロールのクラス。

抽象クラス

Abstract クラス 説明
フィールド 編集可能なフィールドの抽象クラス。
Flyout フライアウトのクラス。

列挙型

列挙 説明
ConnectionType 接続または入力のタイプを表す列挙型。

関数

関数 説明
getFocusManager() FocusManager.getFocusManager のコンビニエンス関数。
hasBubble(obj) 指定されたオブジェクトが IHasBubble かどうかを確認する型ガード。
hideChaff(opt_onlyClosePopups) ツールチップ、コンテキスト メニュー、プルダウン選択などを閉じます。
inject(container, opt_options) 指定されたコンテナ要素(通常は div)に Blockly エディタを挿入します。
isCopyable(obj)
isDeletable(obj) 指定されたオブジェクトが IDeletable かどうかを返します。
isDraggable(obj) 指定されたオブジェクトが IDraggable かどうかを返します。
isIcon(obj) 指定されたオブジェクトが IIcon かどうかを確認する型ガード。
isPaster(obj)
isRenderedElement(obj)
isSelectable(obj) 指定されたオブジェクトが ISelectable かどうかを確認します。
isSerializable(obj) 指定されたオブジェクトが ISerializable かどうかを確認する型ガード。
isVariableBackedParameterModel(param) 指定されたオブジェクトが変数ホルダーかどうかを返します。
navigateBlock(current, delta) 指定されたブロックの子を基準として、次にナビゲート可能な項目を返します。
navigateStacks(current, delta) 指定された要素のスタックを基準として、次のスタックまたは前のスタックを返します。
setLocale(locale)

言語/地域(ローカライズされたメッセージやブロックテキストなど)を指定された言語/地域に設定します。

スクリプトタグから読み込む場合、メッセージは Blockly.Msg オブジェクトに自動的に組み込まれるため、これは有用でも必要でもありません。ただし、tscompiler が型定義ファイルを適切に作成できるように、スクリプトタグと非スクリプトタグの両方のコンテキストで提供しています。

インターフェース

インターフェース 説明
BlocklyOptions Blockly オプション。
FieldCheckboxConfig チェックボックス フィールドの構成オプション。
FieldCheckboxFromJsonConfig チェックボックス フィールドの fromJson 構成オプション。
FieldConfig ベースフィールドの追加の構成オプション。
FieldDropdownFromJsonConfig プルダウン フィールドの fromJson 構成。
FieldImageConfig 画像フィールドの構成オプション。
FieldImageFromJsonConfig 画像フィールドの fromJson 構成オプション。
FieldLabelConfig ラベル フィールドの構成オプション。
FieldLabelFromJsonConfig ラベル フィールドの fromJson 構成オプション。
FieldNumberConfig 数値フィールドの構成オプション。
FieldNumberFromJsonConfig 数値フィールドの fromJson 構成オプション。
FieldTextInputFromJsonConfig テキスト入力フィールドの fromJson 構成オプション。
FieldVariableConfig 変数フィールドの構成オプション。
FieldVariableFromJsonConfig 変数フィールドの fromJson 構成オプション。
IAutoHideable 自動的に非表示にできるコンポーネントのインターフェース。
IBoundedElement 境界付き要素インターフェース。
IBubble バブル インターフェース。
ICollapsibleToolboxItem 折りたたみ可能なツールボックス内のアイテムのインターフェース。
IComponent ComponentManager に登録できるワークスペース コンポーネントのインターフェース。
IConnectionChecker 接続タイプのチェック ロジックのクラス。
IConnectionPreviewer ブロックをドロップした場合に接続される場所のビジュアル「プレビュー」を表示します。
IContextMenu
ICopyable
IDeletable 削除可能なオブジェクトのインターフェース。
IDeleteArea 上にドロップされたブロックまたはバブルを削除できるコンポーネントのインターフェース。
IDraggable ドラッグ可能なオブジェクトを表します。
IDragger
IDragStrategy
IDragTarget ブロックまたはバブルがドラッグされて上にドロップされたときにカスタム動作を行うコンポーネントのインターフェース。
IFlyout フライアウトのインターフェース。
IFlyoutInflater
IFocusableNode 入力フォーカスを持つことができるものを表します。
IFocusableTree

独自の有効/無効のフォーカス コンテキストを持つフォーカス可能な要素のツリーを表します。

フォーカスは FocusManager によって処理され、ツリー実装では一度にフォーカスできる IFocusableNode は 1 つだけです。ツリー自体にフォーカスがある場合、ツリーのフォーカスされたノードは「アクティブ」と見なされます(別のツリーにフォーカスがある場合は「パッシブ」)。

フォーカスは 1 つ以上のツリー間で共有されます。各ツリーにはアクティブ ノードまたはパッシブ ノードが 1 つだけ存在します(ページ全体でアクティブ ノードは常に 1 つだけです)。パッシブ フォーカスは、以前フォーカスされていたツリーに戻ったときにフォーカスが復元される場所をユーザーにコンテキストとして提供することを目的としています。

ツリーの現在のフォーカスされたノード(パッシブまたはアクティブ)が必要な場合は、FocusableTreeTraverser.findFocusedNode を使用できます。

このツリーで特定のノードを取得する必要がある場合は、lookUpFocusableNode または FocusableTreeTraverser.findFocusableNodeFor を使用します。

IHasBubble
IIcon
IKeyboardAccessible キーボード ショートカットを処理するオブジェクトのインターフェース。
ImageProperties 人が読める画像プルダウン オプションの定義。
IMetricsManager 指標マネージャーのインターフェース。
IMovable 移動可能なオブジェクトのインターフェース。
INavigationPolicy キーボード ナビゲーションの移動先を指定する一連のルール。
IPaster データをワークスペースに貼り付けることができるオブジェクト。
IPositionable ワークスペースの上に配置されるコンポーネントのインターフェース。
IRegistrable 登録可能な Blockly コンポーネントのインターフェース。
IRenderedElement
ISelectable

選択可能なオブジェクトのインターフェース。

一般的に、実装では、選択が正しく更新され、選択変更イベントがトリガーされるように、onNodeFocus() と onNodeBlur() の実装を使用して、それぞれ setSelected() を自身と null で呼び出すことが想定されています。

ISelectableToolboxItem 選択可能なツールボックス内のアイテムのインターフェース。
ISerializable
IStyleable スタイルを追加できるオブジェクトのインターフェース。
IToolbox ツールボックスのインターフェース。
IToolboxItem ツールボックス内のアイテムのインターフェース。
IVariableBackedParameterModel 変数モデルを保持するパラメータ モデルのインターフェース。
IVariableMap

変数マップは、ワークスペースで参照される変数のセットを保存して管理するコンテナ オブジェクトです。

これらのメソッドは、どの名前と型が有効であるかについての不変条件を定義し、条件が満たされない場合は例外をスローする可能性があります。

IVariableModel
IVariableState 指定された変数の状態を表します。
ToastOptions トースト通知の表示/構成オプション。

名前空間

名前空間 説明
ブロック
blockAnimations
blockRendering
browserEvents
bubbles
bumpObjects
クリップボード
CollapsibleToolboxCategory
comments
common
ComponentManager
定数
ContextMenu
ContextMenuItems
ContextMenuRegistry
Css
dialog
ドラッグ
イベント
拡張機能
fieldRegistry
geras
アイコン
ICopyable
入力
レイヤ
libraryBlocks
MetricsManager
名前
オプション
手順
registry
RenderedConnection
renderManagement
シリアル化
ShortcutItems
ShortcutRegistry
テーマ
ThemeManager
テーマ
thrasos
Toast スクリーン リーダーでトーストを読み上げる際の積極性のオプション。値は aria-live の値に対応しています。
ToolboxCategory
ToolboxSeparator
ツールチップ
タップ操作
uiPosition
utils
変数
VariablesDynamic
WidgetDiv
Xml
zelos

変数

変数 説明
ブロック ブロックタイプ名とブロック プロトタイプ オブジェクトのマッピング。
COLLAPSE_CHARS
COLLAPSED_FIELD_NAME
COLLAPSED_INPUT_NAME
config デベロッパーが変更できる Blockly のすべての値を保持するオブジェクト。
defineBlocksWithJsonArray Blockly デベロッパー ツールで生成される可能性のある JSON ブロック定義の配列からブロックを定義します。
DELETE_VARIABLE_ID
DropDownDiv
getMainWorkspace メイン ワークスペースを返します。最後に使用されたメイン ワークスペース(フォーカスに基づく)を返します。特にページに複数の Blockly インスタンスがある場合は、この関数を使用しないようにしてください。
getSelected 現在選択されているコピー可能なオブジェクトを返します。
INPUT_VALUE
JavaScript
keyboardNavigationController キーボード ナビゲーション コントローラのシングルトン インスタンス。
Msg ローカライズされたメッセージの辞書。
NEXT_STATEMENT
OPPOSITE_TYPE
OUTPUT_VALUE
PREVIOUS_STATEMENT
PROCEDURE_CATEGORY_NAME ツールボックス XML のカテゴリの「custom」属性で使用する文字列。この文字列は、カテゴリにプロシージャ ブロックを動的に入力する必要があることを示します。
RENAME_VARIABLE_ID
setParentContainer 親コンテナを設定します。これは、Blockly.inject が最初に呼び出されたときに WidgetDiv、dropDownDiv、Tooltip がレンダリングされるコンテナ要素です。最初の 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」属性で使用する文字列。この文字列は、カテゴリに変数ブロックを動的に入力する必要があることを示します。
VERSION Blockly コアのバージョン。この定数は、ビルド スクリプト(npm run build)によって package.json のバージョンの値にオーバーライドされます。これは、buildCompressed gulp タスクの Closure Compiler によって行われます。ローカルビルドでは、--define='Blockly.VERSION=X.Y.Z' をコンパイラに渡して、この定数をオーバーライドできます。

型エイリアス

型エイリアス 説明
FieldCheckboxValidator フィールドの値の変更を検証してから設定するために呼び出される関数。
FieldDropdownConfig プルダウン フィールドの構成オプション。
FieldDropdownValidator フィールドの値の変更を検証してから設定するために呼び出される関数。
FieldNumberValidator フィールドの値の変更を検証してから設定するために呼び出される関数。
FieldTextInputConfig テキスト入力フィールドの構成オプション。
FieldTextInputValidator フィールドの値の変更を検証してから設定するために呼び出される関数。
FieldValidator フィールドの値の変更を検証してから設定するために呼び出される関数。
FieldVariableValidator フィールドの値の変更を検証してから設定するために呼び出される関数。
ICopyData
MenuGenerator FieldDropdown またはその子孫のメニュー オプションの配列、またはメニュー オプションの配列を生成する関数。
MenuGeneratorFunction FieldDropdown またはその子孫のメニュー オプションの配列を生成する関数。
MenuOption プルダウン メニューの個々のオプション。メニュー区切りアイテムの場合は文字列リテラル separator、通常のメニュー アイテムの場合は配列を指定できます。後者の場合、最初の要素は人間が読める値(テキスト、ImageProperties オブジェクト、HTML 要素)で、2 番目の要素は言語に依存しない値です。
ReturnEphemeralFocus

エフェメラル UI フロー(ダイアログなど)の完了時に FocusManager にフォーカスを戻すための型宣言。

詳しくは、FocusManager.takeEphemeralFocus をご覧ください。