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 フライアウト分割点からのキーボード ナビゲーションを制御する一連のルール。フライアウトの区切り線には移動できないため、これは無効なプレースホルダです。
FocusableTreeTraverser 一般的なツリー トラバーサルを支援する IFocusableTree 実装用のヘルパー ユーティリティ。
FocusManager

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

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

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

ジェスチャー 1 つのジェスチャーのクラス。
グリッド ワークスペースのグリッドのクラス。
HorizontalFlyout フライアウトのクラス。
入力 オプション フィールドを含む入力のクラス。
InsertionMarkerPreviewer
LabelFlyoutInflater フライアウトのラベルの作成を担当するクラス。
LineCursor 線カーソルのクラス。
Marker マーカーのクラス。これは、キーボード ナビゲーションにおいて、Blockly AST 内の位置を保存するために使用されます。
MarkerManager ワークスペース上の複数のマーカーとカーソルを管理するクラス。
メニュー 基本的なメニュークラス。
MenuItem メニュー内の項目を表すクラス。
MetricsManager すべてのワークスペース指標の計算の管理者。
名前 エンティティ名(変数、プロシージャなど)のデータベースのクラス。
ナビゲーター キーボード ナビゲーション コマンドに応じてフォーカスを移動する場所を決定するクラス。
オプション ユーザー指定のオプションを解析し、動作が指定されていない場合は妥当なデフォルトを使用します。
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 ズーム コントロールのクラス。

抽象クラス

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

列挙型

列挙 説明
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) 指定されたオブジェクトが変数ホルダーかどうかを返します。
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() の実装を使用して、それぞれ自身と null を指定して setSelected() を呼び出し、選択が正しく更新され、選択変更イベントがトリガーされるようにする必要があります。

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
Msg ローカライズされたメッセージの辞書。
NEXT_STATEMENT
OPPOSITE_TYPE
OUTPUT_VALUE
PREVIOUS_STATEMENT
PROCEDURE_CATEGORY_NAME ツールボックス XML のカテゴリの「カスタム」属性で使用する文字列。この文字列は、カテゴリにプロシージャ ブロックが動的に入力される必要があることを示します。
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 のカテゴリの「カスタム」属性で使用する文字列。この文字列は、カテゴリに変数ブロックを動的に入力する必要があることを示します。
VARIABLE_DYNAMIC_CATEGORY_NAME ツールボックス XML のカテゴリの「カスタム」属性で使用する文字列。この文字列は、カテゴリに変数ブロックを動的に入力する必要があることを示します。
バージョン 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 をご覧ください。