Hérite de WidgetBase.
Fonction
Rendu
Ce widget sert à lancer un plan d’analyse du module stat et afficher le résultat.
Utilisation
Exemple complexe
Dans l’exemple ci-dessous, on a :
- Un bouton qui lance un évènement
stat:exec186
. - Un widget Stat qui peut être lu ainsi :
id_amap="186"
: c’est le plan d’analyse n°186 du module de stats qui va être appelédataset_filter="filter"
: on transmet aussi les données du dataset appeléfilter
comme paramètre (voir plus bas)option_name="exec_event" value="stat:exec186"
: on appelle le module de stats en réponse à l’évènementstat:exec186
donc, ici, lorsqu’on clique sur le boutonoption_name="update_disabled" value="true"
: on ne souhaite pas lancer des appels au module de stats autrement qu’en cliquant sur le boutonoption_name="use_current_user" value="true"
: on souhaite utiliser les droits de l’utilisateur courant pour obtenir les données (donc l’utilisateur courant est sur le même projet et a accès aux bonnes données), c’est une alternative à l’utilisation d’un compte de service
Exemple simple
On aurait aussi pu se limiter à ceci si l’on ne souhaitait pas envoyer de paramètres et qu’on ne souhaite pas de boutons pour lancer les appels.
Le dataset_filter
et l’envoi de paramètres
Si l’attribut dataset_filter
est utilisé :
- Voozanoo va trouver le dataset signalé et s’en servir pour envoyer des paramètres au module de stats
- On peut ensuite les utiliser :
- Dans le script R pour les afficher ou s’en servir pour faire des traitements ou des filtres sur les données
- Dans les dataqueries qui servent de source de données au plan d’analyse (pour des conditions par exemple)
Ceci est souvent utilisé pour permettre à l’utilisateur de rendre ses analyses statistiques dynamiques : il fait des choix dans un court formulaire avant de lancer l’analyse.
Utilisation des paramètres dans les script R
Le code ci-dessous permet de récupérer les paramètres passés sous la forme d’une liste :
Utilisation des paramètres dans les dataqueries
L’exemple ci-dessous attend des paramètres username
et date_max
pour les utiliser comme conditions dans un dataquery qui sert de source de données. L’attribut optional='true'
sert à ignorer ces conditions si les attributs ne sont pas transmis. Si l’attribut dataset_filter
du widget Stat est utilisé, les paramètres que le dataset signalé contient seront transmis au dataquery automatiquement.
Exemple illustré
Attributs
Les attributs nécessaires au bon fonctionnement du widget sont signalés par un astérisque.
Ce widget hérite de fonctionnalités issues d’un autre widget. Consultez la documentation dédiée au WidgetBase pour vérifier si d’autres attributs sont disponibles.
Options
Les options nécessaires au bon fonctionnement du widget sont signalées par un astérisque.
Ce widget hérite de fonctionnalités issues d’un autre widget. Consultez la documentation dédiée au WidgetBase pour vérifier si d’autres options sont disponibles.
data
Todo
-
Version : >=2.26
-
Valeurs possibles : null
data_exec_event_n
Allows calling the stats module in response to the provided event
-
Version : >=2.26
-
Valeurs possibles : null
data_id_amap_n
Allows specifying the analysis plan ID of the Stat Module to be launched.
-
Version : >=2.26
-
Valeurs possibles : null
data_url_n
Allows specifying the URL to which this option applies.
-
Version : >=2.26
-
Valeurs possibles : null
use_current_user
Permet de garder le contexte de l’utilisateur courant lors de l’appel à statmodule. Cette option ne fonctionne que si l’application appelante est l’application contenant les données.
-
Version : >=2.26
-
Valeurs possibles : Boolean