Liste de reflets
L’acteur Liste de reflets affiche, page par page, les reflets du REDY, filtrés selon ses propriétés. Le reflet sélectionné dans la liste est accessible par script ; sa modification déclenche l’évènement onSelectChange.
🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule
Propriétés
Auto rafraîchi?
this.properties.autoRefresh · boolean · défaut true
Active/désactive le rafraîchissement automatique de la donnée.
Colonnes
this.properties.columns · 'id' | 'path' | 'icon' | 'name' | 'isForced' | 'state' · défaut '["icon","name","isForced","state"]' · modifie : Gabarit
Colonnes de la liste.
Délai
this.properties.autoRefreshDelay · number · défaut 30
Délai de rafraîchissement automatique de la donnée.
Entête?
this.properties.displayHeader · boolean · défaut true · modifie : Taille
Active/désactive l’affichage de l’entête de la liste.
Filtre ensemble
this.properties.collection · any · défaut null
Filtre texte
this.properties.searchText · string · défaut ''
Filtre zone
this.properties.zone · any · défaut null
Mode
this.properties.mode · 'all' | 'pending' · défaut 'all'
Pagination?
this.properties.displayPaging · boolean · défaut true · modifie : Taille
Active/désactive l’affichage de la pagination
reflectType
this.properties.reflectType · 'all' | 'analog' | 'digital' | 'text' | 'state' · défaut 'all'
Filtre les reflets par type (all : tous les types). Absente de l’inspecteur : modifiable par script uniquement.
Sélection active?
this.properties.enabled · boolean · défaut true
Taille page
this.properties.pageSize · number · défaut 10
Taille en nombre d’élément d’un page de pagination.
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.
columns
this.columns · 🔒 lecture seule · Array<String>
Clés des colonnes à afficher.
Récupérées depuis Actor.Request.BaseRequestListProperties#columns.
count
this.count · 🔒 lecture seule · Number
Nombre d’éléments total de la liste.
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.
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.
lastRequestDate
this.lastRequestDate · 🔒 lecture seule · String ou null
Date de la dernière requête (ISO 8601), null avant la première.
page
this.page
Numéro de la page en cours (à partir de 1).
reflects
this.reflects
Reflets de la page courante de la liste (lecture seule).
rows
this.rows · 🔒 lecture seule · Array
Ligne de la liste.
C’est un alias de Actor.Request.BaseRequest#data.
selectedReflect
this.selectedReflect
Reflet sélectionné dans la liste ; le modifier déclenche l’évènement onSelectChange.
Méthodes
refresh()
this.refresh()
Effectue un rafraîchissement de la donnée.
request()
this.request() · renvoie Promise<Any>
Effectue une requête.
requestDebounce()
this.requestDebounce() · renvoie Promise<any>
Effectue une requête retardée. Si une requête est déjà en cours, elle part à sa fin.
selectReflect(reflect)
this.selectReflect(reflect)
Sélectionne le reflet donné dans la liste.
Événements
Les évènements communs à tous les acteurs sont décrits avec l’acteur de base.
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 |
onSelectChange
context : contexte d’évènement, avec en plus :
Membre de context | Type | Description |
|---|---|---|
value |
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 :
- BaseRequestList : Acteur de base pour une liste alimentée par requête.
- BaseRequest : Acteur de base pour un acteur alimenté par requête.
- Requesterable (comportement) : Attribut la possibilité à un acteur de réaliser des requêtes.
