Ce widget est utilisé pour représenter un bouton ouvrant une liste déroulante permettant l’export d’un DataQuery
Hérite de WidgetActionList.
Fonction
Rendu
Utilisation
Exporter les données d’un dataquery via l’id_data
L’id_data est disponible dans la colonne “ID” du listing des ressources. Il s’agit de l’id_data de la ressource de type “dataquery” ou “export” en base de données (cette information peut différer d’une base de données à l’autre).
Exporter les données d’un dataquery via le resource_id (sid)
Le resource_id (ou sid) est disponible dans la colonne “Identifiant de la ressource” du listing des ressources. Il s’agit du resource_id de la ressource de type “dataquery” ou “export” en base de données (cette information persiste entre les différentes bases de données).
Exporter les données d’un dataquery contenu dans un formulaire spécifique via la valeur de son attribut id
Dans l’exemple ci-dessous, le widget permettra d’exporter les données du dataquery avec l’id/le nom “structure” contenu dans le formulaire courant. Les données seront d’abord filtrées via le dataset de filtre “search”, également contenu dans le formulaire courant.
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 WidgetActionList 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 WidgetActionList pour vérifier si d’autres options sont disponibles.
action_build
Nom de l’action (ZendFramework) à utiliser lors de la requête XHR liée à la génération du fichier à exporter
-
Version : >=2.15
-
Valeurs possibles : String
-
Valeur par défaut : build
controller
Nom du controller (ZendFramework) à utiliser pour les requêtes XHR liées à l’export
-
Version : >=2.15
-
Valeurs possibles : String
-
Valeur par défaut : index
dataquery_id
id_data dans la table {pj}_resource_data de la ressource de type “export” ou “dataquery” contenant le dataquery à exécuter pour exporter les données. Cette information est disponible dans la colonne “ID” du listing des ressources. Utilisée avec l’option “form_id”, cette option attend comme valeur le nom du dataquery tel que défini dans l’attribut “id” de la balise dataquery au sein du formulaire.
-
Version : >=2.15
-
Valeurs possibles : Integer or string
dataquery_sid
resource_id dans la table {pj}_resource_data de la ressource de type “export” ou “dataquery” contenant le dataquery à exécuter pour exporter les données. Cette information est disponible dans la colonne “Identifiant de la ressource” du listing des ressources.
-
Version : >=2.26
-
Valeurs possibles : string
dataset_filter
Identifiant (alphabétique) du dataset présent dans le formulaire contenant le bouton d’export à utiliser pour filtrer les données
-
Version : >=2.15
-
Valeurs possibles : String
formats
Formats disponibles
-
Version : >=2.15
-
Valeurs possibles : String
-
Valeur par défaut : [‘csv’, ‘dta’, ‘gss’, ‘xlsx’, ‘xls’, ‘codebook’]
form_id
id_data dans la table {pj}_resource_data de la ressource contenant le formulaire où est défini le dataquery à exécuter. Cette information est disponible dans la colonne “ID” du listing des ressources. Cette option accepte également la valeur “current” qui permet à l’utilisateur d’indiquer que le dataquery se trouve dans le formulaire courant.
-
Version : >=2.15
-
Valeurs possibles : Integer
form_sid
resource_id dans la table {pj}_resource_data de la ressource contenant le formulaire où est défini le dataquery à exécuter. Cette information est disponible dans la colonne “Identifiant de la ressource” du listing des ressources.
-
Version : >=2.15
-
Valeurs possibles : string
module
Nom du module (ZendFramework) à utiliser pour les requêtes XHR liées à l’export
-
Version : >=2.15
-
Valeurs possibles : String
-
Valeur par défaut : export
output_name
Nom du fichier qui sera téléchargé.
-
Version : >=2.26
-
Valeurs possibles : String