Studio 1.6.0
Runtime 2.8.0
REDY 16.4.0
Reflet Vanne 3 voies
L’acteur Reflet Vanne 3 voies permet une visualisation détaillée d’une ressource vanne 3 voies avec reflet.
C’est la version avec reflet de l’acteur Vanne 3 voies.
Sommaire
🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule
Propriétés
Auto rafraîchi?
this.properties.autoRefresh · boolean · défaut true
Indique si l’acteur doit automatiquement rafraîchir les données du reflet à intervalles réguliers.
Autonome?
this.properties.isAutonomous · boolean · défaut true
Indique si l’acteur fonctionne de manière autonome, sans nécessiter d’acteur requêteur.
Délai
this.properties.autoRefreshDelay · number · défaut 30
Le délai en secondes entre chaque rafraîchissement automatique des données du reflet.
Détails de reflet au clic
this.properties.withDetails · 'none' | 'top' | 'bottom' | 'left' | 'right' · défaut 'none'
Permet d’ouvrir une modale avec le détail du reflet lorsque l’utilisateur clique sur l’acteur, si le reflet est commandable la modale proposera sa commande.
Orientation
this.properties.orientation · '0' | '90' | '180' | '270' · défaut '0'
Définit l’orientation du dessin de la vanne sur l’interface.
Reflet
this.properties.reflectPath · string · défaut ''
Le chemin vers le reflet REDY que cet acteur doit afficher.
Requêteur
this.properties.requesterKey · string · défaut ''
La clé de l’acteur requêteur responsable de la communication avec le REDY. Nécessaire si isAutonomous est désactivé (false).
Informations
Accessibles par script, via this dans un script de l’acteur ou context.getActor('clé') depuis un autre acteur.
autoRefreshing
this.autoRefreshing · 🔒 lecture seule · Boolean
Indique si le rafraîchissement automatique est actif.
data
this.data
Donnée reçue par la dernière requête.
error
this.error · 🔒 lecture seule · String ou null
Erreur de requête.
fullPath
this.fullPath · 🔒 lecture seule
Obtient le chemin complet vers le reflet.
hasError
this.hasError · 🔒 lecture seule · Boolean
Indique s’il y a eu une erreur de requête.
isRequesting
this.isRequesting · 🔒 lecture seule · Boolean
Indique si la requête est en cours.
isValorized
this.isValorized · 🔒 lecture seule
Indique si la donnée a été valorisée.
lastRequestDate
this.lastRequestDate · 🔒 lecture seule · String ou null
Date de la dernière requête (ISO 8601), null avant la première.
reflect
this.reflect
Obtient le reflet chargé (alias en lecture seule de data).
reflectPath
this.reflectPath · 🔒 lecture seule
Obtient le chemin du reflet relatif au requêteur source (properties.reflectPath).
requesterSource
this.requesterSource
Obtient le requêteur de reflet source.
Méthodes
refresh()
this.refresh()
Effectue un rafraîchissement de la donnée.
request()
this.request()
Effectue une requête : celle de l’acteur s’il est autonome, sinon celle de son requêteur de reflet.
requestDebounce()
this.requestDebounce() · renvoie Promise<any>
Effectue une requête retardée : celle de l’acteur s’il est autonome, sinon celle de son requêteur de reflet.
Événements
Les évènements communs à tous les acteurs sont décrits avec l’acteur de base.
onDidReflectChange
Se produit lorsque l’acteur reçoit un reflet alors qu’il n’en avait pas encore (premier chargement, ou après une requête sans reflet) ; les mises à jour suivantes du même reflet ne le déclenchent pas.
context : contexte d’évènement, avec en plus :
Membre de context | Type | Description |
|---|---|---|
reflect | Object ou null | Le reflet reçu (null si la requête n’en a pas trouvé) |
onRequestDone
Se produit lorsque la requête s’est terminée.
context : contexte d’évènement, avec en plus :
Membre de context | Type | Description |
|---|---|---|
error | String ou Object ou null | Une erreur éventuelle |
data | any | La donnée |
Hérite de
Outre ce qui est décrit ici, l’acteur a tout ce que décrit l’acteur de base : propriétés communes (taille, disposition, aspect, texte, bordures, effets…), évènements communs (cycle de vie, souris, clavier…) et membres accessibles par script.
Il hérite aussi de :
- BaseRequest : Acteur de base pour un acteur alimenté par requête.
- Requesterable (comportement) : Attribut la possibilité à un acteur de réaliser des requêtes.
Fonctionnement
Cet acteur se connecte directement à la source de données de la vanne 3 voies (via un reflet ). Il interprète les informations reçues pour afficher un état de fonctionnement.
La propriété Détails de reflet au click (withDetails) permet d’activer l’affichage d’une modale lors du clic sur un acteur. Cette modale présente un détail de reflet, offrant une visualisation complète des informations du reflet. Si le reflet est commandable, la modale permet également d’interagir avec celui-ci.
Types de reflets compatibles
- Reflet Vanne 3 voies
- Reflet analogique
- Reflet digital
