Agregar una acción de script a un área de texto o un elemento de visualización

Si tiene permisos de autor de scripts, puede definir sus propios scripts y agregarlos a controles de acción en un área de texto, o como una acción al hacer clic para ciertos elementos de visualización, utilizando el cliente instalado. Al usar scripts incluidos en un mod de acción, los autores de análisis que no crean scripts personalmente pueden agregar scripts compartidos desarrollados por firmantes de confianza. Los scripts permiten incorporar acciones simples o herramientas al análisis sin tener que implementar complementos enteros en el servidor. Los scripts tienen acceso completo a la API de Spotfire.

Por qué y cuándo se efectúa esta tarea

Consejo: También puede agregar scripts que no estén vinculados a un área de texto o a una visualización, sino que se realicen cuando una propiedad cambia su valor. Consulte Gestión de scripts en Spotfire para obtener más información.

Por motivos de seguridad, existen restricciones al uso de los scripts. Para obtener más información, consulte Uso de scripts y funciones de datos. Los autores de scripts también deben asegurarse de guardar los scripts de confianza en la biblioteca para que otros usuarios puedan beneficiarse de su trabajo. Para una capacidad de compartir recursos todavía mejor, los scripts se pueden incluir en un mod de acción firmado. Para obtener más información, consulte Administrar la confianza. Consulte Desarrollo de mods para obtener más información sobre los mods de acción.

Consulte también Scripts de ejemplo de IronPython Scripts de IronPython en Spotfire en la Comunidad, donde encontrará muchos más ejemplos sobre el uso de scripts en Spotfire.

En modo HTML también es posible agregar algunas funciones mediante JavaScript editando el HTML del área de texto. Para obtener más información, consulte Ejemplos de scripts JavaScript.

Consejo: En la Comunidad, el artículo Procedimientos recomendados para escribir código JavaScript personalizado en las áreas de texto proporciona un resumen introductorio sobre cómo usar JavaScript en las áreas de texto de Spotfire.

Nota: Las áreas de texto se deben crear en el cliente instalado.

Antes de empezar

Se deben haber cargado algunos datos en el análisis (en el cliente instalado), que debe estar en modo Edición.

Siga los pasos en Agregar acciones a un área de texto o Agregar acciones realizadas al hacer clic en elementos de visualización y asegúrese de seleccionar Script en el paso 3.

Procedimiento

En el cuadro de diálogo Control de acción o Configuración de acción, en Scripts disponibles, haga clic en el script que desee. Si no tiene ningún script disponible en el análisis, puede Agregar scripts existentes desde un archivo de mod de acción (*.mod) o desde un mod de acción en la biblioteca, o puede agregar un script que se haya guardado previamente en un archivo de análisis, ya sea localmente o en la biblioteca. También puede definir un nuevo script, si tiene los permisos necesarios. Para obtener sugerencias sobre cómo definir un nuevo script, consulte Flujos de trabajo de script de ejemplo a continuación.

Nota: Spotfire compara los scripts que intenta importar con aquellos que ya existen. Un script cuyo cuerpo sea idéntico a otro existente no se importará, ni siquiera si tiene un nombre distinto.

El campo Comentario puede contener información acerca de si un script es de confianza o no. Los scripts que usted mismo haya creado serán de confianza, al igual que los scripts que un miembro del grupo de autores de scripts guarde como de confianza en la biblioteca. Los scripts de un mod de acción pueden ser de confianza o no, dependiendo de si el usuario o el administrador han confiado en el mod o en el firmante de antemano.
Si recibe un archivo de análisis que contenga un script directamente de otra persona, este se marcará como "No es de confianza". Esto no quiere decir que el script contenga material peligroso, pero deberá determinar si confía en el script inspeccionándolo en el cuadro de diálogo Editar script. Al hacer clic en Aceptar en el cuadro de diálogo Editar script, se considerará que el script es de confianza. Si sabe que todos los scripts son seguros, puede ir a Administrar confianza y hacer clic en Confiar en todo.

En un entorno de cliente web local de Spotfire, los scripts se pueden ejecutar si provienen de mods de acción de confianza o si un miembro del grupo de autores de scripts los ha guardado como de confianza.
Haga clic en cada parámetro (si los hay) del campo Entrada necesaria para el script seleccionado y especifique la Entrada para el parámetro seleccionado. Si el script necesita algún tipo de valores de entrada, estos se deberán especificar antes de ejecutar el script. Los distintos tipos de parámetros tienen distintas configuraciones de entrada.
Para los parámetros de valor, puede elegir si desea escribir un Valor numérico o basado en texto directamente, asociar el parámetro seleccionado con una Propiedad o calcular el valor mediante una Expresión. Es posible que otros parámetros necesiten una especificación de una visualización, una página o una tabla de datos con la que trabajar.
Cuando los parámetros de todos los scripts estén definidos, haga clic en Aceptar.
Si está agregando una acción a un área de texto, haga clic en Guardar cuando haya terminado.
Si está agregando una acción a un área de texto, haga clic en Cerrar en la esquina superior derecha para salir del cuadro de diálogo Editar área de texto.

Flujos de trabajo de script de ejemplo

A continuación se incluyen más detalles de cómo crear y usar varios ejemplos de scripts en Spotfire. Estos pasos también pueden servir como instrucciones para trabajar cuando se creen scripts propios. Consulte también ejemplos de scripts IronPython.

Creación del script "Cambiar el título de la visualización"

Este ejemplo muestra cómo puede agregar un script que cambie el título de una visualización.

Por qué y cuándo se efectúa esta tarea

Consulte Agregar acciones a un área de texto para obtener información sobre cómo llegar al cuadro de diálogo Control de acción.

Procedimiento

En el cuadro de diálogo Control de acciones, haga clic en Agregar > Nuevo script.
En el cuadro de diálogo Nuevo script, escriba el Nombre del script Cambiar título de la visualización.
En el campo Script, escriba o pegue el script:
```
visual.Title = title
```
Haga clic en Agregar.
En el cuadro de diálogo Agregar parámetro de script, introduzca Título como Nombre y, en Tipo, seleccione Cadena.
El título debe ser una cadena que se pueda definir mediante un valor de texto simple, una propiedad de cadena o una expresión.
Si lo desea, agregue un valor de depuración que se puede usar para probar el script.
Haga clic en Aceptar.
El parámetro "título" se agregará a la lista Parámetros del script.
Haga clic en Agregar para definir el segundo parámetro y, en el cuadro de diálogo Agregar parámetro de script, introduzca Visual como Nombre y, en Tipo, seleccione Visualización.
Este parámetro se usa para determinar la visualización a la que cambiar el título.
Seleccione una visualización de valor de depuración para que se use cuando se pruebe el script.
Haga clic en Aceptar.
El parámetro "visual" se agregará a la lista Parámetros del script.
Si lo desea, pruebe el script haciendo clic en Ejecutar script.

El título de la visualización seleccionada se actualiza con el valor de depuración proporcionado. Haga clic en Deshacer en el cuadro de diálogo Nuevo script para volver al título anterior.
Haga clic en Aceptar.

Resultados

El script "Cambiar título de la visualización" se agregará a la lista Scripts disponibles en el cuadro de diálogo Control de acción y los parámetros definidos se mostrarán en la lista Entrada necesaria para el script seleccionado (siempre y cuando el script esté seleccionado en la lista Scripts disponibles).

Consejo: Para, alternativamente, cambiar el título de la visualización activa, use el siguiente script:

Document.ActiveVisualReference.Title = title

Uso del script "Cambiar el título de la visualización" en un área de texto

Cuando se usa un script en un control de acción, se puede definir cómo proporcionar la entrada necesaria para todos los parámetros del script. Este ejemplo muestra cómo puede utilizar el script del ejemplo anterior en un botón en un área de texto.

Procedimiento

Siga las instrucciones de los pasos anteriores y asegúrese de que el script "Cambiar título de la visualización" esté seleccionado en el cuadro de diálogo Control de acción.
En el cuadro de diálogo Control de acción, en Entrada necesaria para el script seleccionado, haga clic en el Título del parámetro.
En Entrada para el parámetro seleccionado, el usuario determina si desea definir el título usando un Valor, una Propiedad o una Expresión predefinidos. En este ejemplo, haga clic en Propiedad para poder cambiar el título mediante un control de propiedad.
Haga clic en Seleccionar propiedad.
En el cuadro de diálogo Seleccionar propiedad, en la ficha Propiedades del documento, haga clic en Nuevo.
En el cuadro de diálogo Nueva propiedad, escriba un Nombre de la propiedad adecuado, por ejemplo, Título.Visualización.
En la lista desplegable Tipo de datos, seleccione Cadena.
Escriba un valor para que sea el primer valor (la opción predeterminada) de la propiedad. Por ejemplo, Título de mi visualización.
Haga clic en Aceptar para cerrar todos los cuadros de diálogo.
El control de acción se agregará al área de texto.
Haga clic en Guardar cuando haya terminado de editar el área de texto y luego cierre el cuadro de diálogo Editar área de texto.
Pruebe el control de acción haciendo clic en el área de texto.

Consejo: La propiedad que controle el título de la visualización podría, a su vez, modificarse usando un control de propiedad (por ejemplo, un campo de entrada) en el área de texto. Consulte Adición de un control de propiedad a un área de texto y Usar propiedades de documento, tabla de datos o columna en un análisis para ver ejemplos de cómo agregar controles de propiedad.

Creación del script "Cambiar el esquema de filtrado"

Este ejemplo muestra cómo puede agregar un script que cambie el esquema de filtrado.

Por qué y cuándo se efectúa esta tarea

Consulte Agregar acciones a un área de texto

Procedimiento

En el cuadro de diálogo Control de acciones, haga clic en Agregar > Nuevo script.
En el cuadro de diálogo Nuevo script, escriba el Nombre del script Cambiar esquema de filtrado.

En el campo Script, escriba o pegue el 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

El ejemplo de script incluido espera encontrar un esquema de filtrado llamado "Filters2" y cambia el esquema de filtrado de la página activa a dicho esquema.

Haga clic en Aceptar para cerrar el cuadro de diálogo Nuevo script.

Uso del script "Cambiar esquema de filtrado" en un área de texto

Este ejemplo muestra cómo puede utilizar el script creado en el ejemplo anterior en un botón en un área de texto.

Procedimiento

Asegúrese de que el script "Cambiar esquema de filtrado" esté seleccionado en el cuadro de diálogo Control de acción.
Haga clic en Aceptar.
El script no requiere entrada de los usuarios finales, pero, si no hay un esquema de filtrado "Filters2" en el análisis, no pasará nada cuando se haga clic en el control de acción.
Haga clic en Guardar cuando haya terminado de editar el área de texto y luego cierre el cuadro de diálogo Editar área de texto.
Pruebe el control de acción haciendo clic en el área de texto.