blockly

package blockly

Classes

Classe Description
Bloquer Classe pour un bloc. Il n'est normalement pas appelé directement. workspace.newBlock() est à privilégier.
BlockFlyoutInflater Classe chargée de créer des blocs pour les volets.
BlockNavigationPolicy Ensemble de règles contrôlant la navigation au clavier à partir d'un bloc.
BlockSvg Classe pour la représentation SVG d'un bloc. Il n'est normalement pas appelé directement. workspace.newBlock() est à privilégier.
ButtonFlyoutInflater Classe chargée de créer des boutons pour les volets.
CodeGenerator Classe pour un générateur de code qui traduit les blocs dans un langage.
CollapsibleToolboxCategory Classe pour une catégorie dans une boîte à outils pouvant être réduite.
ComponentManager Gestionnaire de tous les éléments enregistrés auprès de l'espace de travail.
Connexion Classe pour une connexion entre des blocs.
ConnectionChecker Classe pour la logique de vérification du type de connexion.
ConnectionDB Base de données de connexions. Les connexions sont stockées dans l'ordre de leur composant vertical. De cette manière, les connexions d'une zone peuvent être recherchées rapidement à l'aide d'une recherche binaire.
ConnectionNavigationPolicy Ensemble de règles contrôlant la navigation au clavier à partir d'une connexion.
ContextMenuRegistry Classe pour le registre des éléments de menu contextuel. Il s'agit d'un singleton. Vous ne devez pas créer d'instance et n'accéder à cette classe que depuis ContextMenuRegistry.registry.
DeleteArea Classe abstraite pour un composant pouvant supprimer un bloc ou une bulle déposé dessus.
DragTarget Classe abstraite pour un composant avec un comportement personnalisé lorsqu'un bloc ou une bulle est glissé ou déposé dessus.
FieldCheckbox Classe pour un champ de case à cocher.
FieldDropdown Classe pour un champ déroulant modifiable.
FieldImage Classe d'une image sur un bloc.
FieldLabel Classe pour un champ de texte non modifiable et non sérialisable.
FieldLabelSerializable Classe pour un champ de texte non modifiable et sérialisable.
FieldNavigationPolicy Ensemble de règles qui contrôlent la navigation au clavier à partir d'un champ.
FieldNumber Classe pour un champ numérique modifiable.
FieldTextInput Classe pour un champ de texte modifiable.
FieldVariable Classe pour le champ déroulant d'une variable.
FlyoutButton Classe d'un bouton ou d'un libellé dans le panneau déroulant.
FlyoutButtonNavigationPolicy Ensemble de règles contrôlant la navigation au clavier à partir d'un bouton à développer.
FlyoutItem Représentation d'un élément affiché dans un panneau déroulant.
FlyoutMetricsManager Calcule les métriques pour l'espace de travail d'un panneau déroulant. Les métriques sont principalement utilisées pour dimensionner les barres de défilement du panneau déroulant.
FlyoutNavigationPolicy Règle de navigation générique qui permet de naviguer entre les éléments du panneau déroulant.
FlyoutNavigator
FlyoutSeparator Représentation d'un espace entre les éléments d'un panneau déroulant.
FlyoutSeparatorNavigationPolicy Ensemble de règles contrôlant la navigation au clavier à partir d'un séparateur de fenêtre pop-up. Il s'agit d'un espace réservé sans opération, car les séparateurs de volets ne peuvent pas être sélectionnés.
FocusableTreeTraverser Utilitaire d'assistance pour les implémentations IFocusableTree afin de faciliter les parcours d'arbre courants.
FocusManager

Singleton par page qui gère la sélection Blockly sur un ou plusieurs IFocusableTrees et synchronise cette sélection de manière bidirectionnelle avec le DOM.

Les appelants qui souhaitent modifier explicitement la sélection de l'entrée pour certains composants Blockly de la page doivent utiliser les fonctions de sélection de ce gestionnaire.

Le gestionnaire est chargé de gérer les événements de sélection du DOM (qui peuvent résulter du clic des utilisateurs sur des éléments de page) et de s'assurer que les IFocusableNodes correspondants sont clairement marqués comme mis en surbrillance de manière active/passive, de la même manière que cela serait représenté avec des appels à focusNode().

Geste Classe pour un seul geste.
Grille Classe pour la grille d'un espace de travail.
HorizontalFlyout Classe pour un pop-up.
Entrée Classe pour une entrée avec des champs facultatifs.
InsertionMarkerPreviewer
LabelFlyoutInflater Classe chargée de créer des libellés pour les pop-ups.
LineCursor Classe pour un curseur de ligne.
Marker Classe pour un repère. Il est utilisé dans la navigation au clavier pour enregistrer un emplacement dans l'AST Blockly.
MarkerManager Classe permettant de gérer les repères multiples et le curseur dans un espace de travail.
Menu Classe de menu de base.
MenuItem Classe représentant un élément dans un menu.
MetricsManager Administrateur de tous les calculs de métriques de l'espace de travail.
Noms Classe pour une base de données de noms d'entités (variables, procédures, etc.).
Navigateur Classe chargée de déterminer où le focus doit se déplacer en réponse aux commandes de navigation au clavier.
Options Analysez les options spécifiées par l'utilisateur, en utilisant des valeurs par défaut raisonnables lorsque le comportement n'est pas spécifié.
RenderedConnection Classe pour une connexion entre des blocs pouvant être affichés à l'écran.
Barre de défilement Classe pour une barre de défilement SVG pure. Cette technique offre une barre de défilement qui fonctionne à coup sûr, mais qui n'a pas forcément le même aspect ni le même comportement que les barres de défilement du système.
ScrollbarPair Classe pour une paire de barres de défilement. Horizontale et verticale.
SeparatorFlyoutInflater Classe chargée de créer des séparateurs pour les volets.
ShortcutRegistry Classe pour le registre des raccourcis clavier. Il s'agit d'un singleton. Vous ne devez pas créer d'instance et n'accéder à cette classe que depuis ShortcutRegistry.registry.
Thème Classe pour un thème.
ThemeManager Classe permettant de stocker et de mettre à jour le thème et les composants d'interface utilisateur d'un espace de travail.
Toast Classe permettant d'afficher et d'ignorer des notifications temporaires.
Boîte à outils Classe pour une boîte à outils. Crée le DOM de la boîte à outils.
ToolboxCategory Classe d'une catégorie dans une boîte à outils.
ToolboxItem Classe d'un élément de la boîte à outils.
ToolboxSeparator Classe pour un séparateur de boîte à outils. Il s'agit de la ligne visuelle fine qui s'affiche dans la boîte à outils. Cet élément n'est pas interactif.
Corbeille Classe pour une corbeille.
UnattachedFieldError Représente une erreur où le champ tente d'accéder à son bloc ou à des informations sur son bloc avant qu'il n'ait été effectivement associé à ce bloc.
VariableMap Classe pour une carte de variables. Il contient une structure de données de dictionnaire avec des types de variables comme clés et des listes de variables comme valeurs. La liste des variables est du type indiqué par la clé.
VariableModel Classe pour un modèle de variable. Contient des informations sur la variable, y compris son nom, son ID et son type.
VerticalFlyout Classe pour un pop-up.
Workspace Classe d'un espace de travail. Il s'agit d'une structure de données contenant des blocs. Il n'y a pas d'interface utilisateur, et il peut être créé sans tête.
WorkspaceAudio Classe permettant de charger, de stocker et de lire de l'audio pour un espace de travail.
WorkspaceDragger Classe pour un outil de glisser-déposer d'espace de travail. Il déplace l'espace de travail lorsqu'il est glissé à l'aide d'une souris ou d'un doigt.
WorkspaceNavigationPolicy Ensemble de règles qui contrôlent la navigation au clavier à partir d'un espace de travail.
WorkspaceSvg Classe d'un espace de travail. Il s'agit d'une zone à l'écran avec une corbeille, des barres de défilement, des bulles et des fonctionnalités de glisser-déposer facultatives.
ZoomControls Classe pour les commandes de zoom.

Classes abstraites

Classe abstraite Description
Champ Classe abstraite pour un champ modifiable.
Volet Classe pour un pop-up.

Énumérations

Enumeration Description
ConnectionType Enumération du type de connexion ou d'entrée.

Fonctions

Fonction Description
getFocusManager() Fonction pratique pour FocusManager.getFocusManager.
hasBubble(obj) Garde-fou de type qui vérifie si l'objet donné est un IHasBubble.
hideChaff(opt_onlyClosePopups) Fermer les info-bulles, les menus contextuels, les sélections dans les menus déroulants, etc.
inject(container, opt_options) Injectez un éditeur Blockly dans l'élément de conteneur spécifié (généralement un div).
isCopyable(obj)
isDeletable(obj) Indique si l'objet donné est un IDeletable.
isDraggable(obj) Indique si l'objet donné est un IDraggable ou non.
isIcon(obj) Protection de type qui vérifie si l'objet donné est un IIcon.
isPaster(obj)
isRenderedElement(obj)
isSelectable(obj) Vérifie si l'objet donné est un ISelectable.
isSerializable(obj) Protection de type qui vérifie si l'objet donné est un ISerializable.
isVariableBackedParameterModel(param) Indique si l'objet donné est un conteneur de variable ou non.
setLocale(locale)

Définit les paramètres régionaux (c'est-à-dire les messages/textes de bloc/etc. localisés) sur les paramètres régionaux donnés.

Cela n'est pas utile/nécessaire lors du chargement à partir d'une balise de script, car les messages sont automatiquement insérés dans l'objet Blockly.Msg. Toutefois, nous le fournissons à la fois dans les contextes de balise de script et de non-balise de script afin que le compilateur ts puisse créer correctement nos fichiers de définition de type.

Interfaces

Interface Description
BlocklyOptions Options Blockly.
FieldCheckboxConfig Options de configuration pour le champ de case à cocher.
FieldCheckboxFromJsonConfig Options de configuration fromJson pour le champ de case à cocher.
FieldConfig Options de configuration supplémentaires pour le champ de base.
FieldDropdownFromJsonConfig Configuration fromJson pour le champ déroulant.
FieldImageConfig Options de configuration pour le champ d'image.
FieldImageFromJsonConfig Options de configuration fromJson pour le champ image.
FieldLabelConfig Options de configuration pour le champ du libellé.
FieldLabelFromJsonConfig Options de configuration fromJson pour le champ de libellé.
FieldNumberConfig Options de configuration pour le champ de nombre.
FieldNumberFromJsonConfig Options de configuration fromJson pour le champ de nombre.
FieldTextInputFromJsonConfig Options de configuration fromJson pour le champ de saisie de texte.
FieldVariableConfig Options de configuration pour le champ de variable.
FieldVariableFromJsonConfig Options de configuration fromJson pour le champ de variable.
IAutoHideable Interface d'un composant pouvant être masqué automatiquement.
IBoundedElement Interface d'élément limité.
IBubble Interface à bulles.
ICollapsibleToolboxItem Interface d'un élément de la boîte à outils pouvant être réduit.
IComponent Interface d'un composant de l'espace de travail pouvant être enregistré auprès du ComponentManager.
IConnectionChecker Classe pour la logique de vérification du type de connexion.
IConnectionPreviewer Affiche des "aperçus" visuels de l'emplacement où un bloc sera connecté s'il est placé.
IContextMenu
ICopyable
IDeletable Interface d'un objet pouvant être supprimé.
IDeleteArea Interface d'un composant pouvant supprimer un bloc ou une bulle déposés dessus.
IDraggable Représente un objet pouvant être déplacé.
IDragger
IDragStrategy
IDragTarget Interface d'un composant avec un comportement personnalisé lorsqu'un bloc ou une bulle est glissé ou déposé dessus.
IFlyout Interface d'un panneau déroulant.
IFlyoutInflater
IFocusableNode Représente tout élément pouvant être sélectionné.
IFocusableTree

Représente une arborescence d'éléments sélectionnables avec son propre contexte de sélection actif/passif.

Notez que la sélection est gérée par FocusManager, et que les implémentations d'arborescences ne peuvent avoir qu'une seule IFocusableNode sélectionnée à la fois. Si l'arbre lui-même est sélectionné, le nœud sélectionné de l'arbre est considéré comme "actif" ("passif" si un autre arbre est sélectionné).

Le focus est partagé entre une ou plusieurs arborescences, où chaque arborescence peut avoir exactement un seul nœud actif ou passif (et un seul nœud actif peut exister sur l'ensemble de la page à un moment donné). L'idée de la sélection passive est de fournir aux utilisateurs un contexte sur l'endroit où leur sélection sera restaurée lorsqu'ils reviendront à un arbre précédemment sélectionné.

Notez que si le nœud actuellement sélectionné (passif ou actif) de l'arborescence est nécessaire, vous pouvez utiliser FocusableTreeTraverser.findFocusedNode.

Notez que si des nœuds spécifiques doivent être récupérés pour cet arbre, utilisez lookUpFocusableNode ou FocusableTreeTraverser.findFocusableNodeFor.

IHasBubble
IIcon
IKeyboardAccessible Interface d'un objet qui gère les raccourcis clavier.
ImageProperties Définition d'une option de menu déroulant d'image lisible par l'utilisateur.
IMetricsManager Interface d'un gestionnaire de métriques.
IMovable Interface d'un objet mobile.
INavigationPolicy Ensemble de règles qui spécifient où la navigation au clavier doit se poursuivre.
IPaster Objet pouvant coller des données dans un espace de travail.
IPositionable Interface d'un composant placé au-dessus de l'espace de travail.
IRegistrable Interface d'un composant Blockly pouvant être enregistré.
IRenderedElement
ISelectable

Interface d'un objet sélectionnable.

Les implémentations doivent généralement utiliser leurs implémentations de onNodeFocus() et onNodeBlur() pour appeler setSelected() avec elles-mêmes et null, respectivement, afin de s'assurer que les sélections sont correctement mises à jour et que l'événement de changement de sélection est déclenché.

ISelectableToolboxItem Interface d'un élément de la boîte à outils pouvant être sélectionné.
ISerializable
IStyleable Interface d'un objet auquel un style peut être ajouté.
IToolbox Interface d'une boîte à outils.
IToolboxItem Interface d'un élément de la boîte à outils.
IVariableBackedParameterModel Interface pour un modèle de paramètre contenant un modèle de variable.
IVariableMap

Les cartes de variables sont des objets de conteneur chargés de stocker et de gérer l'ensemble de variables référencées dans un espace de travail.

Chacune de ces méthodes peut définir des invariants sur les noms et les types autorisés, et générer une exception si ces invariants ne sont pas respectés.

IVariableModel
IVariableState Représente l'état d'une variable donnée.
ToastOptions Options d'affichage/de configuration d'une notification toast.

Espaces de noms

Espace de noms Description
Bloquer
blockAnimations
blockRendering
browserEvents
bulles
bumpObjects
Presse-papiers
CollapsibleToolboxCategory
comments
communs
ComponentManager
constantes
ContextMenu
ContextMenuItems
ContextMenuRegistry
CSS
dialog
déplacer
Événements
Extensions
fieldRegistry
geras
icônes
ICopyable
entrées
couches
libraryBlocks
MetricsManager
Noms
Options
Procédures
registry
RenderedConnection
renderManagement
sérialisation
ShortcutItems
ShortcutRegistry
Thème
ThemeManager
Thèmes
thrasos
Toast Options de lecture des notifications toast par les lecteurs d'écran. Les valeurs correspondent à celles d'aria-live.
ToolboxCategory
ToolboxSeparator
Info-bulle
Tactile
uiPosition
utils
Variables
VariablesDynamic
WidgetDiv
Xml
zelos

Variables

Variable Description
Blocages Mappage des noms de types de blocs sur les objets de prototype de bloc.
COLLAPSE_CHARS
COLLAPSED_FIELD_NAME
COLLAPSED_INPUT_NAME
config Objet contenant toutes les valeurs de Blockly que les développeurs devraient pouvoir modifier.
defineBlocksWithJsonArray Définissez des blocs à partir d'un tableau de définitions de blocs JSON, comme cela peut être généré par les outils pour les développeurs Blockly.
DELETE_VARIABLE_ID
DropDownDiv
getMainWorkspace Renvoie l'espace de travail principal. Renvoie le dernier espace de travail principal utilisé (en fonction de la sélection). Essayez de ne pas utiliser cette fonction, en particulier s'il existe plusieurs instances Blockly sur une page.
getSelected Renvoie l'objet copiable actuellement sélectionné.
INPUT_VALUE
JavaScript
Msg Dictionnaire de messages localisés.
NEXT_STATEMENT
OPPOSITE_TYPE
OUTPUT_VALUE
PREVIOUS_STATEMENT
PROCEDURE_CATEGORY_NAME Chaîne à utiliser dans l'attribut "custom" d'une catégorie dans le fichier XML de la boîte à outils. Cette chaîne indique que la catégorie doit être renseignée dynamiquement avec des blocs de procédure.
RENAME_VARIABLE_ID
setParentContainer Définissez le conteneur parent. Il s'agit de l'élément de conteneur dans lequel WidgetDiv, dropDownDiv et Tooltip sont affichés la première fois que Blockly.inject est appelé. Cette méthode est une instruction NOP si elle est appelée après le premier Blockly.inject.
svgResize Ajustez la taille de l'image SVG pour qu'elle remplisse entièrement son conteneur. Appelez cette méthode lorsque la vue change de taille (par exemple, en cas de redimensionnement de la fenêtre ou de changement d'orientation de l'appareil). Consultez workspace.resizeContents pour redimensionner l'espace de travail lorsque le contenu change (par exemple, lorsqu'un bloc est ajouté ou supprimé). Enregistrez la hauteur/largeur de l'image SVG.
TOOLBOX_AT_BOTTOM
TOOLBOX_AT_LEFT
TOOLBOX_AT_RIGHT
TOOLBOX_AT_TOP
VARIABLE_CATEGORY_NAME Chaîne à utiliser dans l'attribut "custom" d'une catégorie dans le fichier XML de la boîte à outils. Cette chaîne indique que la catégorie doit être renseignée dynamiquement avec des blocs de variables.
VARIABLE_DYNAMIC_CATEGORY_NAME Chaîne à utiliser dans l'attribut "custom" d'une catégorie dans le fichier XML de la boîte à outils. Cette chaîne indique que la catégorie doit être renseignée dynamiquement avec des blocs de variables.
VERSION Version de base de Blockly. Cette constante est remplacée par la valeur de la version dans package.json par le script de compilation (npm run build). C'est le compilateur Closure qui s'en charge dans la tâche gulp buildCompressed. Pour les compilations locales, vous pouvez transmettre --define='Blockly.VERSION=X.Y.Z' au compilateur pour remplacer cette constante.

Alias de type

Alias de type Description
FieldCheckboxValidator Fonction appelée pour valider les modifications apportées à la valeur du champ avant qu'elles ne soient définies.
FieldDropdownConfig Options de configuration pour le champ déroulant.
FieldDropdownValidator Fonction appelée pour valider les modifications apportées à la valeur du champ avant qu'elles ne soient définies.
FieldNumberValidator Fonction appelée pour valider les modifications apportées à la valeur du champ avant qu'elles ne soient définies.
FieldTextInputConfig Options de configuration pour le champ de saisie de texte.
FieldTextInputValidator Fonction appelée pour valider les modifications apportées à la valeur du champ avant qu'elles ne soient définies.
FieldValidator Fonction appelée pour valider les modifications apportées à la valeur du champ avant qu'elles ne soient définies.
FieldVariableValidator Fonction appelée pour valider les modifications apportées à la valeur du champ avant qu'elles ne soient définies.
ICopyData
MenuGenerator Un tableau d'options de menu ou une fonction qui génère un tableau d'options de menu pour FieldDropdown ou ses descendants.
MenuGeneratorFunction Fonction qui génère un tableau d'options de menu pour FieldDropdown ou ses descendants.
MenuOption Une option individuelle dans le menu déroulant. Il peut s'agir de la chaîne littérale separator pour un élément de séparateur de menu ou d'un tableau pour les éléments de menu d'action normaux. Dans ce dernier cas, le premier élément correspond à la valeur lisible par l'humain (texte, objet ImageProperties ou élément HTML), et le second à la valeur neutre.
ReturnEphemeralFocus

Déclaration de type pour rétablir le focus sur FocusManager à la fin d'un flux d'UI éphémère (par exemple, une boîte de dialogue).

Pour en savoir plus, consultez FocusManager.takeEphemeralFocus.