Journal des variables

L’acteur Journal des variables affiche un tableau contenant les évènements de journaux du REDY.

Sommaire

🔧 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.

Aux couleurs des classes

this.properties.colorsFromClasses · boolean · défaut false

Colonnes

this.properties.columns · 'id' | 'ack' | 'icon' | 'date' | 'nod' | 'site' | 'state' | 'todo' · défaut '["ack","icon","date","nod","state"]' · modifie : Gabarit

Colonnes de la liste.

Dans l’entête du tableau vous trouverez les définitions des colonnes. La liste des colonnes est paramétrable. C’est pour l’instant un tableau de clé en JSON :

["id", "ack", "icon", "date", "nod", "site", "state", "todo"]
clé de colonne Description
id Index de l’évènement
ack Acquittement
icon Icône de l’évènement
date Date de l’évènement
nod Variable à l’origine de l’évènement
site Site de l’élément à l’origine de l’évènement
state État de la ressource
todo Consigne

Laissez vide la propriété Colonnes pour les afficher toutes.

Délai

this.properties.autoRefreshDelay · number · défaut 30

Délai de rafraîchissement automatique de la donnée.

Depuis

this.properties.dateFrom · any · défaut null

Entête?

this.properties.displayHeader · boolean · défaut true · modifie : Taille

Active/désactive l’affichage de l’entête de la liste.

Une propriété permet de faire disparaître l’entête.

Filtre ensemble

this.properties.collection · any · défaut null

Filtre équipement

this.properties.device · any · défaut null

Filtre évènements acquittés

this.properties.acquitted · 'all' | 'notAcquitted' | 'acquitted' · défaut 'all'

Filtre groupes

this.properties.groups · any · défaut null

Filtre site

this.properties.site · any · défaut null

Filtre variable

this.properties.nodPath · any · défaut null

Filtre zone

this.properties.zone · any · défaut null

Jusqu’au

this.properties.dateTo · 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

Une propriété permet de faire disparaître les boutons de pagination.

Taille page

this.properties.pageSize · number · défaut 10

Taille en nombre d’élément d’un page de pagination.

La liste des évènements est paginée, c’est-à-dire que seul un nombre paramétrable est affichée en même temps. Des boutons permettent de naviguer de page en page.

Rafraîchissement

Le journal est mis à jour suivant un délai qui est paramétrable. Ce rafraîchissement peut être désactivé.

Les filtres

Vous pouvez choisir de filtrer les évènements dans le temps, ne voir que les encours, par attributs (groupe, ensemble, zone, …) ou même par variable.

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).

rows

this.rows · 🔒 lecture seule · Array

Ligne de la liste.

C’est un alias de Actor.Request.BaseRequest#data.

wosEvents

this.wosEvents

Évènements WOS de la page courante du journal (lecture seule).

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.

É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

L’évènement onRequestDone est déclenché lorsque l’acteur a terminé une requête vers le REDY pour obtenir ou rafraîchir la liste à afficher.

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.