blockly > Bloquer

Classe de bloc

Classe pour un bloc. Il n'est normalement pas appelé directement. workspace.newBlock() est à privilégier.

Signature :

export declare class Block 

Constructeurs

Constructeur	Modificateurs	Description
(constructeur)(espace de travail, nom du prototype, opt_id)		Construit une instance de la classe Block.

Propriétés

Propriété	Modificateurs	Type	Description
childBlocks_	protected	this[]
collapsed_	protected	booléen
COLLAPSED_FIELD_NAME	static readonly	chaîne	ID neutre en termes de langue attribué au champ réduit.
COLLAPSED_INPUT_NAME	static readonly	chaîne	ID neutre par rapport à la langue attribué à l'entrée réduite.
colour_	protected	chaîne	Couleur du bloc au format "#RRGGBB".
compose ?		(rootBlock: Block) => void	(Facultatif) Méthode facultative qui reconfigure le bloc en fonction du contenu de la boîte de dialogue de modification.
contextMenu		booléen
données		string | null	Données textuelles facultatives qui effectuent des aller-retours entre les blocs et le fichier XML. Aucun effet Peut être utilisé par des tiers pour les métadonnées.
décomposer ?		(workspace: Workspace) => Block	(Facultatif) Fonction facultative qui remplit le pop-up du modificateur avec des blocs représentant la configuration de ce bloc.
destroy ?		() => void	(Facultatif) Méthode facultative appelée lors de la suppression.
disposer	protected	booléen	Le bloc actuel est-il en cours de suppression ?
domToMutation?		(p1: Element) => void	(Facultatif) Méthode de désérialisation facultative permettant de définir comment désérialiser l'état de la mutation à partir du format XML. Cette opération doit être associée à la définition de mutationToDom.
getDeveloperVariables ?		() => string[]	(Facultatif) Méthode facultative permettant de déclarer des variables de développement à utiliser par les générateurs. Les variables de développement ne sont jamais affichées à l'utilisateur, mais sont déclarées comme variables globales dans le code généré.
chapeau ?		chaîne	(Facultatif) Nom du type de chapeau.
helpUrl		string | (() => string) | null	Chaîne d'aide pour le bloc ou fonction renvoyant une URL. "Null" pour aucune aide.
icônes		IIcon[]
id		chaîne
init ?		() => void	(Facultatif) Méthode facultative appelée lors de l'initialisation.
inputList		Entrée[]
inputsInline?		booléen	(Facultatif)
inputsInlineDefault?		booléen	(Facultatif)
isInFlyout		booléen
isInMutator		booléen
isInsertionMarker_	protected	booléen	"True" si ce bloc est un repère d'insertion.
loadExtraState?		(p1: any) => void	(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 la mutation) à partir d'un élément compatible avec JSON. Cette opération doit être associée à la définition de saveExtraState.
mutationToDom?		(...p1: any[]) => Element	(Facultatif) Méthode de sérialisation facultative permettant de définir comment sérialiser l'état de la mutation au format XML. Cette opération 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. Elle n'est généralement appelée que depuis le constructeur, la fonction d'initialisation du type de bloc ou une fonction d'initialisation d'extension.
outputConnection		Connexion | null
outputShape_	protected	number | null
parentBlock_	protected	this | null
previousConnection		Connexion | null
rendu	readonly	booléen	Ce bloc est-il un BlockSVG ?
RTL		booléen
saveExtraState?		(doFullSerialization?: boolean) => any	(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 la mutation) dans un format compatible avec JSON. Cette opération 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 d'empêcher l'ajout de STATEMENT_PREFIX et STATEMENT_SUFFIX au code généré.
info-bulle		Tooltip.TipInfo
type		chaîne
espace de travail		Workspace

Méthodes

Méthode	Modificateurs	Description
addIcon(icon)		Ajoute l'icône donné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 de cette pile.
appendDummyInput(name)		Ajoute une ligne d'entrée fictive.
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 de relevé.
appendValueInput(name)		Ajoute une ligne d'entrée de valeur.
bumpNeighbours()		Désaligner les blocs non connectés. Deux blocs qui ne sont pas réellement connectés ne doivent pas se trouver par hasard alignés à l'écran.
dispose(healStack)		Supprimez 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	Appele la fonction init() et gère le déclenchement d'événements associés, etc.
getChildren(ordered)		Recherchez tous les blocs qui sont directement imbriqués dans celui-ci. Inclut les entrées de valeur et d'instruction, 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()		Obtenir la couleur d'un bloc
getCommentText()		Renvoie le commentaire associé à ce bloc (ou la valeur nulle s'il n'y a pas de commentaire).
getDescendants(ordered)		Recherchez tous les blocs qui sont directement ou indirectement imbriqués dans celui-ci. Inclut ce bloc dans la liste. Inclut les entrées de valeur et d'instruction, ainsi que les instructions suivantes. Excluit toute connexion dans un onglet de sortie ou toute instruction précédente. Les blocs peuvent être triés par position, de haut en bas.
getDisabledReasons()		Obtenez un ensemble de raisons pour lesquelles le blocage est actuellement désactivé, le cas échéant. Si le blocage est activé, cet ensemble sera vide.
getField(name)		Renvoie le champ nommé à partir d'un bloc.
getFields()		Renvoie un générateur qui fournit tous les champs du bloc. Générateur pouvant être utilisé pour itérer les champs du bloc.
getFieldValue(name)		Renvoie la valeur neutre en termes de langue du champ donné.
getHue()		Obtenez la valeur de teinte HSV d'un bloc. Valeur nulle si la teinte n'est pas définie.
getIcon(type)
getIcons()
getInheritedDisabled()		Indique si le blocage est désactivé ou non en raison du contrôle parental. La propriété "désactivé" du bloc n'est pas prise en compte.
getInput(name)		Récupère l'objet d'entrée nommé.
getInputsInline()		Indique 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'instructions suivant directement connecté à ce bloc.
getOutputShape()		Obtenez la forme de sortie du bloc.
getParent()		Renvoie le bloc parent ou une valeur nulle si ce bloc se trouve au niveau supérieur. Le bloc parent est le bloc connecté à la connexion précédente (pour un bloc d'instruction) ou 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 du coin supérieur gauche de ce bloc par rapport à l'origine de la surface de dessin (0,0), en unités d'espace de travail.
getRootBlock()		Renvoie le bloc le plus élevé dans l'arborescence de ce bloc. Il se renverra lui-même si ce bloc se trouve au niveau supérieur.
getStyleName()		Récupérez le nom du style de bloc.
getSurroundParent()		Renvoie le bloc parent qui entoure le bloc actuel, ou "null" si ce bloc n'a pas de bloc environnant. Un bloc parent peut simplement être l'instruction précédente, tandis que le bloc environnant est une instruction "si", une boucle "while", etc.
getTooltip()		Renvoie le texte de l'info-bulle pour ce bloc.
getVars()		Renvoie toutes les variables référencées par ce bloc.
hasDisabledReason(reason)		Indique si le blocage est actuellement désactivé pour la raison indiquée.
hasIcon(type)
initModel()		Appelez initModel sur tous les champs du bloc. Peut être appelé plusieurs fois. initModel ou initSvg doit être appelé après la création d'un bloc et avant la première interaction avec celui-ci. Les interactions incluent les actions de l'UI (par exemple, cliquer et faire glisser) et le déclenchement d'événements (par exemple, créer, supprimer et modifier).
isCollapsed()		Indique si le bloc est réduit ou non.
isDeletable()		Indique si ce bloc peut être supprimé ou non.
isDisposed()		Indique si ce bloc a été supprimé.
isDuplicatable()		Indique si le bloc peut être dupliqué ou non. Si la duplication de ce bloc et de ses descendants dépasse la capacité de l'espace de travail, ce bloc ne peut pas être dupliqué. Si la duplication de ce bloc et de ses descendants place un type au-dessus de son nombre maximal d'instances, ce bloc ne peut pas être dupliqué.
isEnabled()		Indique si ce blocage est activé ou non. Un bloc est considéré comme activé s'il n'y a aucune raison de le désactiver. Un blocage peut toujours être désactivé pour d'autres raisons, même si l'utilisateur tente de l'activer manuellement, par exemple lorsque le blocage se trouve dans un emplacement non valide.
isInsertionMarker()		Indique si ce bloc est un bloc de repère d'insertion ou non.
isOwnDeletable()		Indique si la propriété "deletable" de ce bloc est définie sur "true" ou "false".
isOwnEditable()		Indique si la propriété éditable de ce bloc est définie sur "true" ou "false".
isShadow()		Indique si ce bloc est un bloc d'ombre ou non.
jsonInit(json)		Initialisez ce bloc à l'aide d'une description JSON multiplate-forme, adaptée à l'internationalisation.
mixin(mixinObj, opt_disableCheck)		Ajoutez les clés/valeurs de mixinObj à cet objet de 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. Cela permet de se prémunir contre les incompatibilités des mixins / extensions avec les futures fonctionnalités de bloc. Cette vérification peut être désactivée en transmettant "true" comme deuxième argument.
moveBy(dx, dy, reason)		Déplacer un bloc d'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 de ce bloc.
removeIcon(type)		Supprime de la section le bloc dont l'icône dont le getType correspond au type iconType donné.
removeInput(name, opt_quiet)		Supprimez une entrée de ce bloc.
renameVarById(oldId, newId)		Notification d'un changement de nom d'une variable. Si l'ID correspond à l'une des variables de ce bloc, renommez-le.
setCollapsed(collapsed)		Indique si le bloc est réduit ou non.
setColour(colour)		Modifier la couleur d'un bloc
setCommentText(text)		Définissez le texte du commentaire de ce bloc.
setDeletable(deletable)		Indique si ce bloc peut être supprimé ou non.
setDisabledReason(disabled, reason)		Ajoutez ou supprimez un motif de désactivation du blocage. Si un bloc doit être désactivé pour une raison quelconque, il sera considéré comme désactivé. Un blocage peut être désactivé simultanément pour plusieurs raisons indépendantes, par exemple lorsque l'utilisateur le désactive manuellement ou que le blocage est non valide.
setEditable(editable)		Indiquez si ce bloc est modifiable ou non.
setFieldValue(newValue, name)		Définit la valeur du champ donné pour ce bloc.
setHelpUrl(url)		Définissez l'URL de la page d'aide de ce bloc.
setInputsInline(newBoolean)		Définissez si les entrées de valeur sont disposées horizontalement ou verticalement.
setMovable(movable)		Déterminez si ce bloc est déplaçable ou non.
setMutator(_mutator)		Attribuez à ce bloc une boîte de dialogue de modification.
setNextStatement(newBoolean, opt_check)		Définissez si un autre bloc peut se lier en 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. Elle n'est généralement appelée que depuis le constructeur, la fonction d'initialisation du type de bloc ou une fonction d'initialisation d'extension.
setOutput(newBoolean, opt_check)		Définissez si ce bloc renvoie une valeur.
setOutputShape(outputShape)		Définissez la forme de sortie du bloc.
setPreviousStatement(newBoolean, opt_check)		Définissez si ce bloc peut se lier en bas d'un autre bloc.
setStyle(blockStyleName)		Définissez le style et les valeurs de couleur d'un bloc.
setTooltip(newTip)		Définit l'info-bulle de 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, en anglais uniquement). Destiné à être utilisé dans les journaux de la console et les erreurs. Si vous avez besoin d'une chaîne qui utilise la langue maternelle de l'utilisateur (y compris le texte du bloc, les valeurs des champs et les blocs enfants), utilisez toString().
toString(opt_maxLength, opt_emptyToken)		Créez une représentation textuelle lisible par l'humain de ce bloc et de ses enfants.
unplug(opt_healStack)		Débranchez ce bloc de son bloc supérieur. Si ce bloc est une instruction, vous pouvez reconnecter le bloc du dessous au bloc du dessus.