Ajout d’une action de script à une zone de texte ou à un élément de visualisation

En tant qu’utilisateur de Spotfire Analyst (et auteur de scripts), à l'aide du client installé, vous pouvez définir vos propres scripts et les ajouter aux commandes d’action dans une zone de texte ou en tant qu’action sur clic pour certains éléments de visualisation. En utilisant les scripts inclus dans un mod d’action, les analystes qui ne créent pas eux-mêmes de scripts peuvent ajouter des scripts partagés développés par des signataires approuvés. Les scripts vous permettent d’incorporer de simples actions ou outils à votre analyse sans devoir déployer l’ensemble des compléments sur le serveur. Les scripts disposent d'un accès complet à l'API (interfaces de programmation) Spotfire.

Pourquoi et quand exécuter cette tâche

Pour plus d’informations sur les mods d’action, consultez la rubrique Développement de mods.

Pour des raisons de sécurité, l’utilisation des scripts est soumise à certaines restrictions. Pour plus d'informations, consultez la rubrique Utilisation des scripts et des fonctions de données. Les auteurs de scripts doivent également veiller à enregistrer les scripts sécurisés dans la bibliothèque afin que les autres utilisateurs puissent tirer parti de leur travail. Pour simplifier le partage, les scripts peuvent être inclus dans un mod d’action signé. Pour plus d'informations, consultez la rubrique Gérer les approbations.

Pour découvrir d’autres exemples sur l’utilisation des scripts dans Spotfire, consultez également l’article IronPython Scripting in Spotfire (Scripts IronPython dans Spotfire) sur le site de la communauté.

En mode HTML, il est également possible d’ajouter quelques fonctionnalités à l’aide de JavaScript en modifiant le fichier HTML de la zone de texte. Pour plus d'informations, consultez la rubrique Exemples de scripts JavaScript.

Conseil : Dans la Communauté, l'article Best Practices for Writing Custom JavaScript Code in Text Areas (Meilleures pratiques pour l'écriture d'un code JavaScript personnalisé dans des zones de texte) donne un aperçu préliminaire de la manière d'utiliser les scripts JavaScript dans une zone de texte dans Spotfire.

Remarque : Les zones de texte doivent être créées dans le client installé.

Avant de commencer

Vous devez avoir plusieurs données chargées dans l’analyse (dans le client installé) et l’analyse doit être en mode Modification.

Suivez les étapes des rubriques Ajout d’actions à une zone de texte ou Ajout d’actions effectuées en cliquant sur des éléments de visualisation et assurez-vous de sélectionner Script à l'étape 3.

Procédure

Dans la boîte de dialogue Commande d’action ou Paramètres d’action, sous Scripts disponibles, cliquez sur le script de votre choix. Si aucun script n’est disponible dans l’analyse, vous pouvez Ajouter des scripts existants à partir d’un fichier de mod d’action (*.mod) ou à partir d’un mod d’action de la bibliothèque. Vous pouvez également ajouter un script préalablement enregistré dans un fichier d’analyse, soit localement, soit dans la bibliothèque. S vous disposez des autorisations requises, vous pouvez également définir un nouveau script. Pour obtenir des conseils sur la façon de définir un nouveau script, consultez la rubrique Exemples de flux de travail de script ci-dessous.

Remarque : Spotfire compare les scripts que vous essayez d'importer avec les scripts existants. Un script dont le corps est identique à celui d'un script existant ne sera pas importé, même si son nom est différent.

Le champ Remarque peut contenir des informations vous aidant à déterminer si vous pouvez ou non faire confiance au script. Les scripts que vous avez créés sont approuvés, de même que les scripts enregistrés comme scripts de confiance dans la bibliothèque par un membre du groupe Auteur de script. Les scripts d’un mod d’action peuvent être approuvés ou non, selon que vous ou l’administrateur avez préalablement approuvé le mod ou le signataire.
Si vous recevez directement de la part d’un tiers un fichier d’analyse comportant un script, ce script sera considéré comme « Non approuvé ». Cela ne signifie pas nécessairement que le script est un document dangereux, mais il vous incombe d’évaluer sa fiabilité en l’inspectant dans la boîte de dialogue Modifier le script. Cliquez sur OK dans la boîte de dialogue Modifier le script pour approuver le script. Si vous savez que tous les scripts sont fiables, vous pouvez accéder à la boîte de dialogue Gérer les approbations et cliquer sur le bouton Approuver tout.

Toutefois, pour des raisons de sécurité, les scripts ne peuvent pas être utilisés dans un environnement client Web TIBCO Cloud Spotfire à moins qu’ils ne proviennent de mods d’action approuvés. Dans un environnement de client Web local Spotfire, les scripts peuvent être exécutés s’ils proviennent de mods d’action approuvés ou s’ils sont enregistrés comme scripts approuvés par un membre du groupe Auteurs de script.
Cliquez sur chaque paramètre (le cas échéant) dans le champ Entrée nécessaire pour le script sélectionné et spécifiez l’Entrée pour le paramètre sélectionné. Si le script nécessite un certain type de valeurs d'entrée, alors celles-ci doivent être spécifiées pour que le script puisse être exécuté. Différents types de paramètres ont différents paramètres d'entrée.
Pour les paramètres de valeur, vous pouvez choisir de saisir directement une Valeur textuelle ou numérique, d’associer le paramètre sélectionné à une Propriété ou de calculer la valeur via une Expression. D’autres paramètres peuvent nécessiter la spécification d’une visualisation, d’une page ou d’une table de données à utiliser.
Lorsque tous les paramètres de script ont été définis, cliquez sur OK.
Si vous ajoutez une action à une zone de texte, cliquez sur Enregistrer lorsque vous avez terminé.
Si vous ajoutez une action à une zone de texte, cliquez sur Fermer dans le coin supérieur droit pour quitter la boîte de dialogue Modifier la zone de texte.

Exemples de flux de travail de script

Vous trouverez ci-dessous plus de détails sur la création et l'utilisation de scripts d'exemple dans Spotfire. Ces étapes peuvent également vous servir d'instructions pour la création de vos propres scripts. Consultez également Exemples de scripts IronPython.

Création du script « Modifier le titre de la visualisation »

Cet exemple montre comment ajouter un script qui modifie le titre d’une visualisation.

Pourquoi et quand exécuter cette tâche

Pour plus d’informations sur la façon d’accéder à la boîte de dialogue Commande d’action, consultez la rubrique Ajout d’actions à une zone de texte.

Procédure

Dans la boîte de dialogue Commande d’action, cliquez sur Ajouter > Nouveau script.
Dans la boîte de dialogue Nouveau script, saisissez le Nom du script Modifier le titre de la visualisation.
Dans le champ Script, saisissez ou collez votre script :
```
visual.Title = title
```
Cliquez sur Ajouter.
Dans la boîte de dialogue Ajouter un paramètre de script, saisissez titre comme Nom et sous Type, sélectionnez Chaîne.
Le titre doit être une chaîne pouvant être définie par une simple valeur de texte, une propriété de chaîne ou une expression.
Si vous le souhaitez, ajoutez une Valeur de débogage pouvant être utilisée pour tester le script.
Cliquez sur OK.
Le paramètre « titre » est ajouté à la liste Paramètres du script.
Cliquez sur Ajouter pour définir le deuxième paramètre. Dans la boîte de dialogue Ajouter un paramètre de script, saisissez visuel comme Nom, et sous Type, sélectionnez Visualisation.
Ce paramètre est utilisé pour désigner la visualisation dont le titre doit être modifié.
Sélectionnez une visualisation en tant que Valeur de débogage à utiliser lors du test du script.
Cliquez sur OK.
Le paramètre « visuel » est ajouté à la liste Paramètres du script.
Si vous le souhaitez, testez le script en cliquant sur Exécuter le script.

Le titre de la visualisation sélectionné est mis à jour avec la valeur de débogage fournie. Cliquez sur Annuler dans la boîte de dialogue Nouveau script pour rétablir l’ancien titre.
Cliquez sur OK.

Résultats

le script « Modifier le titre de la visualisation » est ajouté à la liste Scripts disponibles dans la boîte de dialogue Commande d’action et les paramètres définis sont affichés dans la liste Entrée nécessaire pour le script sélectionné (du moment que le script est sélectionné dans la liste Scripts disponibles).

Conseil : Pour modifier le titre de la visualisation active, utilisez le script suivant :

Document.ActiveVisualReference.Title = title

Utilisation du script « Modifier le titre de la visualisation » dans une zone de texte

Lorsque vous utilisez un script dans une commande d’action, vous pouvez définir la façon de fournir les entrées nécessaires pour tous les paramètres du script. Cet exemple montre la façon d’utiliser le script de l’exemple précédent sur un bouton dans une zone de texte.

Procédure

Suivez les étapes ci-dessus et assurez-vous que le script « Modifier le titre de la visualisation » est sélectionné dans la boîte de dialogue Commande d’action.
Dans la boîte de dialogue Commande d’action, sous Entrée nécessaire pour le script sélectionné, cliquez sur le titre du paramètre.
Sous Entrée pour le paramètre sélectionné, indiquez si vous souhaitez définir le titre à l’aide d’une valeur prédéfinie, d’une propriété ou d’une expression. Dans cet exemple, cliquez sur Propriété pour pouvoir modifier le titre à l’aide d’une commande de propriété.
Cliquez sur Sélectionner propriété.
Dans la boîte de dialogue Sélectionner propriété, sous l’onglet Propriétés du document, cliquez sur Nouveau.
Dans la boîte de dialogue Nouvelle propriété, saisissez un Nom de propriété approprié, par exemple visualisation.titre.
Dans la liste déroulante Type de données, sélectionnez Chaîne.
Saisissez la Valeur que vous souhaitez placer en première position (par défaut) dans la propriété. Par exemple, Titre de ma visualisation.
Cliquez sur OK pour fermer toutes les boîtes de dialogue.
La commande d'action est ajoutée à la zone de texte.
Cliquez sur Enregistrer lorsque vous avez terminé de modifier la zone de texte et fermez la boîte de dialogue Modifier la zone de texte.
Testez la commande d'action en cliquant dessus dans la zone de texte.

Conseil : La propriété contrôlant le titre de la visualisation peut à son tour être modifié à l'aide d'une commande de propriété (par exemple un champ d'entrée) dans la zone de texte. Pour découvrir des exemples de la façon dont vous pouvez ajouter des commandes de propriété, consultez les rubriques Ajout d’une commande de propriété à une zone de texte et Utilisation des propriétés d'un document, d'une table de données ou d'une colonne dans une analyse.

Création du script « Modifier le schéma de filtrage »

Cet exemple montre la façon d’ajouter un script qui modifie le schéma de filtrage.

Pourquoi et quand exécuter cette tâche

Consultez la rubrique Ajout d’actions à une zone de texte.

Procédure

Dans la boîte de dialogue Commande d’action, cliquez sur Ajouter > Nouveau script.
Dans la boîte de dialogue Nouveau script, saisissez le Nom du script Modifier le schéma de filtrage.

Dans le champ Script, saisissez ou collez votre script :

from Spotfire.Dxp.Application.Filters import FilterPanel

# Get hold of the filters panel for the current page.
panels = Document.ActivePageReference.Panels
# The return value and out parameters are returned as a tuple
# in IronPython and can be bound with pattern matching.
(found, filterPanel) = panels.TryGetPanel[FilterPanel]()

# Find the filtering selection named "Filters2"
# and set it as current.
for filteringScheme in Document.FilteringSchemes:
   filteringSelection = filteringScheme.FilteringSelectionReference
   if filteringSelection.Name == "Filters2":
       filterPanel.FilteringSchemeReference = filteringScheme

Cet exemple de script est conçu pour trouver un schéma de filtrage intitulé « Filters2 » et modifie le schéma de filtrage de la page active dans le schéma de filtrage Filters2.

Cliquez sur OK pour fermer la boîte de dialogue Nouveau script.

Utilisation du script « Modifier le schéma de filtrage » dans une zone de texte

Cet exemple montre la façon d’utiliser le script créé dans l’exemple précédent sur un bouton d’une zone de texte.

Procédure

Assurez-vous que le script « Modifier le schéma de filtrage » est sélectionné dans la boîte de dialogue Commande d’action.
Cliquez sur OK.
Ce script ne nécessite aucune entrée de la part des utilisateurs finaux, mais si aucun schéma de filtrage intitulé « Filters2 » n'est présent dans l'analyse, rien ne se passera lorsque vous cliquez sur la commande d'action.
Cliquez sur Enregistrer lorsque vous avez terminé de modifier la zone de texte, puis fermez la boîte de dialogue Modifier la zone de texte.
Testez la commande d'action en cliquant dessus dans la zone de texte.