blockly > Bloquer

Bloquer le cours

Classe pour un bloc. Normalement, il n'est pas appelé directement. Il est préférable d'utiliser workspace.newBlock().

Signature :

export declare class Block implements IASTNodeLocation, IDeletable 

Implémentation: IASTNodeLocation, IDeletable

Constructeurs

Constructeur Les modificateurs Description
(constructeur)(workspace, nomprototype, id_opt) Construit une instance de la classe Block.

Propriétés

Propriété Les modificateurs Type Description
childBlocks_ protected ce[]
collapsed_ protected boolean
COLLAPSED_FIELD_NAME

static

readonly

chaîne ID indépendant de la langue attribué au champ réduit.
COLLAPSED_INPUT_NAME

static

readonly

chaîne ID indépendant de la langue attribué à l'entrée réduite.
colour_ protected chaîne Couleur du bloc au format "#RRGGBB".
compose? (p1: Bloquer) => vide (Facultatif) Fonction facultative qui reconfigure le bloc en fonction du contenu de la boîte de dialogue du mutateur.
contextMenu boolean
données chaîne | null Données textuelles facultatives qui circulent entre les blocs et le format XML. Aucun effet Peut être utilisé par des tiers pour les métadonnées.
décomposer ? (p1: Workspace) => Bloquer (Facultatif) Fonction facultative qui remplit la boîte de dialogue du mutateur avec les composants de ce bloc.
destroy? () => vide (Facultatif) Méthode facultative appelée lors de la mise au rebut.
domToMutation? (p1: Élément) => vide (Facultatif) Méthode de désérialisation facultative permettant de définir comment désérialiser l'état de la mutation à partir d'un fichier XML. Elle doit être associée à la définition de mutationToDom.
getDeveloperVariables? () => chaîne[] (Facultatif) Propriété facultative permettant de déclarer des variables de développeur. Renvoyez une liste de noms de variables à utiliser par les générateurs. Les variables de développeur ne sont jamais présentées à l'utilisateur, mais sont déclarées en tant que variables globales dans le code généré.
chapeau ? chaîne (Facultatif) Nom du type de casquette.
helpUrl string | Function | null Chaîne d'aide sur le bloc ou fonction renvoyant une URL. Null en l'absence d'aide.
icônes IIcon[]
id chaîne
init? () => vide (Facultatif) Méthode facultative appelée lors de l'initialisation.
inputList Entrée[]
inputsInline? boolean (Facultatif)
inputsInlineDefault? boolean (Facultatif)
isInFlyout boolean
isInMutator boolean
isInsertionMarker_ protected boolean "True" si ce bloc est un repère d'insertion.
loadExtraState? (p1: n'importe lequel) => vide (Facultatif) Méthode de sérialisation facultative permettant de définir comment désérialiser l'état supplémentaire du bloc (par exemple, l'état de mutation) à partir d'un élément compatible avec JSON. Elle doit être associée à la définition de saveExtraState.
mutationToDom? (...p1: any[]) => Élément (Facultatif) Méthode de sérialisation facultative permettant de définir comment sérialiser l'état de la mutation en XML. Elle doit être associée à la définition de domToMutation.
nextConnection Connexion | null
onchange? ((p1: Abstract) => void) | null (Facultatif) Méthode de rappel facultative à utiliser chaque fois que l'espace de travail parent du bloc change. Cette méthode n'est généralement appelée qu'à partir du constructeur, de la fonction d'initialisation de type bloc ou d'une fonction d'initialisation d'extension.
outputConnection Connexion | null
outputShape_ protected nombre | nul
parentBlock_ protected cette | nulle
previousConnection Connexion | null
rendu boolean | null
RTL boolean
saveExtraState? (doFullSerialization?: booléen) => tout (Facultatif) Méthode de sérialisation facultative permettant de définir comment sérialiser l'état supplémentaire du bloc (par exemple, l'état de mutation) pour qu'il soit compatible avec le format JSON. Elle doit être associée à la définition de loadExtraState.
styleName_ protected chaîne Nom du style de bloc.
suppressPrefixSuffix boolean | null Propriété facultative permettant de supprimer l'ajout de STATEMENT_PREFIX et STATEMENT_SUFFIX au code généré.
info-bulle Tooltip.TipInfo
type chaîne
workspace Workspace

Méthodes

Méthode Les modificateurs Description
addIcon(icon) Ajoute l'icône indiquée au bloc.
allInputsFilled(opt_shadowBlocksAreFilled) Vérifie de manière récursive si toutes les entrées d'instructions et de valeurs sont remplies de blocs. Vérifie également tous les blocs d'instructions suivants dans cette pile.
appendDummyInput(name) Ajoute une ligne d'entrée factice.
appendEndRowInput(name) Ajoute une entrée qui termine la ligne.
appendInput(input)

Ajoute la ligne d'entrée donnée.

Permet d'ajouter des entrées personnalisées au bloc.

appendStatementInput(name) Ajoute une ligne d'entrée d'instruction.
appendValueInput(name) Ajoute une ligne d'entrée de valeur.
bumpNeighbours() Accrochez les blocs non connectés pour les désaligner. Deux blocs qui ne sont pas réellement reliés entre eux ne doivent pas s'aligner par coïncidence à l'écran.
dispose(healStack) Mettez au rebut ce bloc.
disposeInternal() protected Élimine ce bloc sans effectuer les actions requises par le bloc supérieur. (par exemple, il ne déclenche pas d'événements, ne débranche pas le bloc, etc.).
doInit_() protected Appelle la fonction init() et gère le déclenchement des événements associés, etc.
getChildren(ordered) Recherchez tous les blocs directement imbriqués dans celui-ci. Inclut les valeurs et les déclarations, ainsi que toute instruction suivante. Exclut toute connexion sur un onglet de sortie ou toute instruction précédente. Les blocs peuvent être triés par position, de haut en bas.
getColour() Permet d'obtenir la couleur d'un bloc.
getCommentText() Renvoie le commentaire sur ce bloc (ou la valeur "null" en l'absence de commentaire).
getDescendants(ordered) Recherchez tous les blocs directement ou indirectement imbriqués dans celui-ci. Inclut ce bloc dans la liste. Inclut les valeurs et les déclarations, ainsi que les instructions suivantes. Exclut toute connexion sur un onglet de sortie ou toute instruction précédente. Les blocs peuvent être triés par position, de haut en bas.
getField(name) Renvoie le champ nommé à partir d'un bloc.
getFieldValue(name) Renvoie la valeur neutre en matière de langue du champ donné.
getHue(). Permet d'obtenir la valeur de teinte HSV d'un bloc. Null si aucune teinte n'est définie.
getIcon(type)
getIcons()
getInheritedDisabled() Déterminez si le blocage est désactivé ou non en raison de parents. La propriété désactivée du bloc n'est pas prise en compte.
getInput(name) Récupère l'objet d'entrée nommé.
getInputsInline() Déterminez si les entrées de valeur sont disposées horizontalement ou verticalement.
getInputTargetBlock(name) Récupère le bloc associé à l'entrée nommée.
getInputWithBlock(block) Renvoie l'entrée qui se connecte au bloc spécifié.
getNextBlock() Renvoie le bloc d'instruction suivant directement connecté à ce bloc.
getOutputShape() Permet d'obtenir la forme de sortie du bloc.
getParent() Renvoie le bloc parent ou la valeur "null" si ce bloc se trouve au niveau supérieur. Le bloc parent est soit le bloc connecté à la connexion précédente (pour un bloc d'instruction), soit le bloc connecté à la connexion de sortie (pour un bloc de valeur).
getPreviousBlock() Renvoie le bloc connecté à la connexion précédente.
getRelativeToSurfaceXY() Renvoie les coordonnées de l'angle supérieur gauche de ce volume par rapport à l'origine de la surface de dessin (0,0), dans les unités de l'espace de travail.
getRootBlock() Renvoie le bloc de niveau supérieur dans l'arborescence de ce bloc. Cette valeur s'affiche de manière automatique si ce bloc se trouve au niveau supérieur.
getStyleName() Permet d'obtenir le nom du style de bloc.
getSurroundParent() Return the parent block that surrounds the current block, or null if this block has no surrounding block. Un bloc parent peut simplement être l'instruction précédente, tandis que le bloc qui l'entoure est une instruction if, une boucle, etc.
getTooltip() Affiche le texte de l'info-bulle pour ce bloc.
getVars() Renvoie toutes les variables référencées par ce bloc.
hasIcon(type)
initModel() Appeler initModel sur tous les champs du bloc. Peut être appelé plusieurs fois. initModel ou initSvg doivent être appelés après la création d'un bloc et avant la première interaction avec celui-ci. Les interactions incluent les actions de l'interface utilisateur (par exemple, les clics et les glisser-déposer) et les événements de déclenchement (par exemple, créer, supprimer et modifier).
isCollapsed() Indique si le bloc est réduit ou non.
isDeletable() Détermine si ce bloc peut être supprimé.
isDisposed() Renvoie si ce bloc a été supprimé ou supprimé.
isDuplicatable() Déterminez si le bloc est dupliqué ou non. Si la duplication de ce bloc et de ses descendants entraîne le dépassement de la capacité de l'espace de travail, ce bloc n'est pas dupliqué. Si la duplication de ce bloc et de ses descendants entraîne le remplacement de n'importe quel type par ses valeurs maxInstances, ce bloc n'est pas dupliqué.
isEnabled() Vérifiez si ce bloc est activé ou non.
isInsertionMarker() Indique si ce bloc est un bloc de repère d'insertion ou non.
isOwnDeletable() Indique si la propriété pouvant être supprimée de ce bloc est définie sur "true" ou "false".
isOwnEditable() Indique si la propriété modifiable de ce bloc est "true" ou "false".
isShadow() Déterminez s'il s'agit ou non d'un bloc fantôme.
jsonInit(json) Initialisez ce bloc à l'aide d'une description JSON multiplate-forme compatible avec l'internationalisation.
mixin(mixinObj, opt_disableCheck) Ajoutez des clé-valeurs de mixinObj à cet objet bloc. Par défaut, cette méthode vérifie que les clés de mixinObj n'écrasent pas les valeurs existantes du bloc, y compris les valeurs de prototype. Vous vous assurez ainsi contre les incompatibilités entre les mixin et les extensions avec les futures fonctionnalités de bloc. Vous pouvez désactiver cette vérification en transmettant "true" comme deuxième argument.
moveBy(dx, dy, motif) Déplacer un volume selon un décalage relatif
moveInputBefore(name, refName) Déplacez une entrée nommée vers un autre emplacement de ce bloc.
moveNumberedInputBefore(inputIndex, refIndex) Déplacez une entrée numérotée vers un autre emplacement dans ce bloc.
removeIcon(type) Supprime du bloc l'icône dont getType correspond au type donné iconType.
removeInput(name, opt_quiet) Supprimez une entrée de ce bloc.
renameVarById(oldId, nouvelId) Notification indiquant qu'une variable est en cours de changement de nom. Si l'ID correspond à l'une des variables de ce bloc, renommez-le.
setCollapsed(collapsed) Indiquez si le bloc est réduit ou non.
setColour(colour) Modifier la couleur d'un bloc.
setCommentText(text) Définissez le texte des commentaires de ce bloc.
setDeletable(deletable) Indiquez si ce bloc peut être supprimé ou non.
setEditable(editable) Indiquez si ce bloc peut être modifié ou non.
setEnabled(enabled) Indiquez si le blocage est activé ou non.
setFieldValue(newValue, name) Définit la valeur du champ indiqué pour ce bloc.
setHelpUrl(url) Définissez l'URL de la page d'aide de ce blocage.
setInputsInline(newBoolean) Déterminez si les entrées de valeur sont disposées horizontalement ou verticalement.
setMovable(movable) Indiquez si ce bloc peut être déplacé ou non.
setMutator(_mutator) Attribuez une boîte de dialogue de mutateur à ce bloc.
setNextStatement(newBoolean, opt_check) Indiquez si un autre bloc peut être relié au bas de ce bloc.
setOnChange(onchangeFn) Définit une fonction de rappel à utiliser chaque fois que l'espace de travail parent du bloc change, en remplaçant tout gestionnaire onchange précédent. Cette méthode n'est généralement appelée qu'à partir du constructeur, de la fonction d'initialisation de type bloc ou d'une fonction d'initialisation d'extension.
setOutput(newBoolean, opt_check) Déterminez si ce bloc renvoie une valeur.
setOutputShape(outputShape) Définissez la forme de sortie du bloc.
setPreviousStatement(newBoolean, opt_check) Indiquez si ce bloc peut être relié au bas d'un autre bloc.
setStyle(blockStyleName) Définissez les valeurs de style et de couleur d'un bloc.
setTooltip(newTip) Définit l'info-bulle pour ce bloc.
setWarningText(_text, _opt_id) Définissez le texte d'avertissement de ce bloc.
toDevString()

Cette méthode renvoie une chaîne décrivant ce bloc en termes de développeur (nom et ID de type ; anglais uniquement).

Destiné à être utilisé dans les journaux de la console et les erreurs. Si vous avez besoin d'une chaîne dans la langue maternelle de l'utilisateur (y compris du texte de bloc, des valeurs de champ et des blocs enfants), utilisez [toString()].

toString(opt_maxLength, opt_emptyToken) Créez une représentation textuelle lisible de ce bloc et des enfants.
unplug(opt_healStack). Débranchez ce bloc du bloc supérieur. Si ce bloc est une instruction, vous pouvez éventuellement reconnecter le bloc situé en dessous avec le bloc en haut.