El componente outputChart de ICEfaces

0
8604

Índice de contenidos

  1. Introducción
  2. Preparación del entorno
  3. Creando gráficas con la etiqueta <outputchart>
  4. Generar gráficas dinámicamente
  5. Gráficas personalizadas
  6. Conclusiones

01. Introducción

ICEfaces es un entorno de representación web para aplicaciones Java Server Faces, que aumenta las capacidades del framework JSF para crear interfaces utilizando AJAX y ofrece una rica librería de componentes personalizados para mejorar la presentación de nuestras páginas.

En este tutorial nos centramos en el componente outputChart de ICEfaces, que permite la representación de gráficas circulares o de ejes. Veremos como crear gráficas utilizando la etiqueta «outputChart» en páginas JSP o por medio de código en nuestras clases Java.

Este componente utiliza internamente la librería de código abierto JCharts. Veremos también como crear gráficas más complejas con el API de JCharts y enlazarlas a componentes «outputChart».

02. Preparación del entorno

Para la realización de este tutorial se han utilizado las siguientes herramientas:

Abrimos el entorno de desarrollo y creamos un nuevo proyecto web dinámico.

Vamos a añadir el soporte para Java Server Faces, abriendo las propiedades del proyecto y seleccionando «Facetas de proyecto». Marcamos la opción para «JavaServer Faces» (y si queremos la versión 1.2).

Facetas del proyecto

En la parte inferior de la ventana nos aparece un enlace, indicando que se requiere configuración adicional. Lo pulsamos y nos aparece la siguiente ventana.

Configuración de JSF

Dejamos la implementación JSF del servidor y añadimos la librería de componentes de ICEfaces pulsando sobre el botón «new».

Librería de componentes de ICEfaces

Añadimos las siguientes librerías necesarias a la carpeta «WebContent/WEB-INF/lib». Todas estas librerías pueden encontrarse dentro de la carpeta lib de la distribución de ICEfaces que hemos descargado.

Librerías del servidor

Ahora sólamente nos resta configurar el fichero «web.xml» para añadir el soporte de ICEfaces.

 

Algunos componentes de ICEfaces, como outputChart, generan recursos (en este caso imágenes) que realmente no están almacenados en un fichero en el servidor. El Blocking Servlet recibirá las peticiones de esas imágenes, que se habrán generado dinámicamente, para que sean mostradas en la página.

El mapeo para las urls de la forma «/xmlhttp/*» también será necesario, especialmente al utilizar un actionListener disparado al pulsar sobre los elementos de las gráficas.

03. Creando gráficas con la etiqueta <outputchart>

Para comprobar que nuestra configuración es correcta vamos a crear una sencilla página de prueba, a la que llamaremos «prueba.jsp». En esta página vamos a insertar una gráfica gracias al componente «outputchart» de ICEfaces. La etiqueta <outputchart> debe ir dentro de un formulario, de lo contrario se producirá un error.

 

Si ponemos la etiqueta sin especificar ningún atributo, se utilizarán los valores por defecto. Esto nos mostrará una gráfica de barras parecida a la siguiente.

Gráfica por defecto

Como curiosidad, el color por defecto de las barras es aleatorio, y podrá cambiar si ejecutamos la aplicación varias veces.

La etiqueta «outputchart» dispone principalmente de los siguientes atributos, que nos permiten personalizar la apariencia de las gráficas.

Atributo Subtipo Valor Descripción Ejemplo Resultado Notas
type circulares «pie2d» Gráfica circular en 2 dimensiones <ice:outputCharttype=»pie2d»/> Gráfica pie2d Admite una única serie de datos
«pie3d» Gráfica circular en 3 dimensiones <ice:outputCharttype=»pie3d»/> Gráfica pie3d Admite una única serie de datos. No se muestra la leyenda, porque las etiquetas se muestran junto a cada rodaja
de ejes «area» Muestra el área rellena bajo la gráfica <ice:outputCharttype=»area» data=»40, 20, 30 : 10, 20, 10″/> Gráfica area
«areastacked» Muestra áreas apiladas (para varias series de datos) <ice:outputCharttype=»areastacked»data=»40, 20, 30 : 10, 20, 10″/> Gráfica areastacked
«bar» Diagrama simple de barras <ice:outputCharttype=»bar» data=»40, 20, 30″/> Gráfica bar
«barclustered» Muestra unas barras al lado de las otras (para varias series de datos) <ice:outputCharttype=»barclustered»data=»40, 20, 30 : 10, 20, 50 : 20, 30, 40″/> Gráfica barclustered
«barstacked» Muestra barras apiladas unas sobre otras (para varias series de datos) <ice:outputCharttype=»barstacked»data=»10, 20, 30 : 30, 30, 10″/> Gráfica barstacked
«line» Muestra puntos y líneas entre ellos <ice:outputCharttype=»line» data=»10, 20, 30 : 30, 10, 20″/> Gráfica line
«point» Muestra sólamente puntos <ice:outputCharttype=»point» data=»10, 20, 30 : 30, 10, 20″/> Gráfica point
«custom» Diagrama personalizado Ver apartado degráficas personalizadas
chartTitle String Título de la gráfica <ice:outputChart type=»pie3d»chartTitle=»TITULO»height=»200″/> Título de gráfica
labels String []
List<String>
Nombres de las etiquetas de la gráfica.
Debe haber una etiqueta por cada serie de datos o por cada valor en gráficas circulares
<ice:outputChart type=»barstacked»labels=»Uno, Dos»data=»10, 20, 30 : 20, 50, 10″ /> Gráfica con atributo labels
data double []
double [] []
List<double>
List<double []>
Valores de las series de datos.
Cada serie puede separarse con «:»
<ice:outputChart type=»barstacked» labels=»Uno, Dos»data=»38.9, 20.5 : 20, 50.0″ /> Gráfica con atributo data
colors String []
List<java.awt.Color>
Colores para las diferentes series de datos o las rodajas de los gráficos circulares. Debe haber un color por cada serie de datos o por cada valor en gráficas circulares <ice:outputChart type=»pie2d»colors=»green, red, yellow» data=»10, 20, 70″ /> Gráfica con atributo colors
height String Alto de la imagen generada (gráfcia completa, incluyendo títulos y etiquetas) en píxeles <ice:outputChartheight=»200″ /> Gráfica con atributo height
width String Ancho de la imagen generada en píxeles <ice:outputChartwidth=»200″ /> Gráfica con atributo width
legendPlacement «top», «bottom«, «left», «right», «none» Colocación de la leyenda. «none» indica que no se muestre <ice:outputChartlegendPlacement=»right»/> Gráfica con atributo legendplacement Sin efecto para el tipo «pie3d»
legendColumns Integer Número de columnas que se mostrarán en la leyenda <ice:outputChart type=»barstacked» labels=»A, B, C» data=»10 : 40 : 35″legendColumns=»2″ /> Gráfica con atributo legendColumns Sin efecto para el tipo «pie3d»
horizontal boolean Indica que las barras se muestren horizontalmente <ice:outputChart type=»bar»horizontal=»true»/> Gráfica con atributo horizontal Sólo es válido para los tipos «bar» y «barclustered»
xaxisTitle String Título del eje X <ice:outputChartxaxisTitle=»Eje X»yaxisTitle=»Eje Y»/> Gráfica con atributos xaxisTitle e yaxisTitle Válido para gráficas con ejes
yaxisTitle String Título del eje Y
xaxisLabels String []
List<String>
Rótulos del eje X. Debe haber un rótulo por cada valor de las series de datos <ice:outputChart type=»barclustered» labels=»Serie 1, Serie 2″ data=»10, 20, 30 : 15, 13, 40″xaxisLabels=»2001, 2002, 2003″/> Gráfica con atributo xaxisLabels Válido para gráficas con ejes
shapes String [] (valores «circle», «diamond», «square» o «triangle»)
List<java.awt.Shape>
Forma de los puntos para las gráficas de líneas y puntos. Debe haber tantas formas como series de datos <ice:outputChart type=»line»shapes=»circle, triangle»data=»10, 20 : 13, 19″/> Gráfica con atributo shapes Válido para tipos «line» y «point»
renderOnSubmit boolean Por defecto, la gráfica se genera una vez y vuelve a obtenerse en sucesivas peticiones. Si este valor es true, se volverá a generar la gráfica. <ice:outputChart chartTitle=»Autentia»renderOnSubmit=»true»data=»30, 40″ labels=»hola»/> Gráfica con atributo renderOnSubmit
styleClass String (por defecto «iceOutChrt» o «iceOutChrt-dis» cuando el componente está deshabilitado) Lista de clases CSS separadas por coma para el elemento. <style type=»text/css»>
.grafica {
border: 10px solid red;
float: right;}
</style>
<ice:outputChart styleClass=»grafica»/>
Gráfica con atributo styleClass
actionListener String Método que se lanzará al pulsar sobre algún elemento de la gráfica Ver apartado degráficas personalizadas

Por supuesto, además de insertar directamente los valores en las páginas JSP, podemos enlazar estos valores con propiedades de nuestros bean manejados, como con cualquier componente de JSF.

 

04. Generar gráficas dinámicamente

Ahora que hemos visto cómo funciona la etiqueta OutputChart, vamos a ver un ejemplo de cómo generar componentes dinámicamente, a través de la clase «com.icesoft.faces.component.outputchart.OutputChart». Por medio de esta clase podemos asignar básicamente las mismas propiedades que con la etiqueta, pero desde nuestro código Java.

Creamos la clase «EjemploGraficas» que generará dos componentes de tipo OutputChart y los añadirá a un componente HtmlPanelGrid.

 

Modificamos el fichero «faces-config.xml» para añadir un bean manejado de la clase anterior.

 

Modificamos «prueba.jsp» de forma que sólamente contenga un panel enlazado a la propiedad «panel» de nuestro bean manejado.

 

Cuando se muestre la JSP se ejecutará el constructor de nuestra clase, el cual añadirá las gráficas al panel. El resultado será el siguiente:

Visualización de las gráficas

05. Gráficas personalizadas

Con lo visto hasta ahora podemos generar un amplio abanico de gráficas, personalizando casi todas sus características importantes. Pero en ocasiones, puede que eso no sea suficiente.

Si queremos generar algo más complejo como, por ejemplo, varios tipos diferentes de series (barras, líneas, áreas…) en una misma gráfica, podemos hacerlo utilizando directamente el API de «jCharts», sobre el que se apoya el componente «outputChart». De esta manera podremos generar cualquier gráfica que pueda generarse con «jCharts» y después enlazarla con nuestro componente visual.

Vamos a ver un ejemplo en el que generaremos una gráfica con series de datos que incluyan barras y líneas. Además, veremos cómo utlizar la propiedad «actionListener» del componente para disparar un evento al pulsar sobre algún valor de la gráfica.

Creamos la clase «EjemploJChart» dentro del paquete «backing»:

 

Esta clase genera una gráfica de ejemplo que presenta gastos e ingresos a lo largo de un trimestre. Las series de gastos se representan con líneas, mientras que las de ingresos lo hacen mediante barras verticales. Por simplicidad se han añadido únicamente dos o tres series de cada tipo.

El método actualizar es el que realiza la generación de la gráfica cuando ésta aún no se ha inicializado, e irá enlazado con la propiedad «renderOnSubmit» del componente. Cuando se vaya a visualizar el componente se llamará a este método y, si es la primera vez, se generará la gráfica.

Es importante notar que podemos tener diferentes conjuntos de datos, pero en cada uno debe cumplirse lo siguiente:

  • La cardinalidad de «leyenda», «colores» y «datos» debe ser la misma, ya que se refieren a una misma serie.
  • La cardinalidad de cada uno de los elementos de «datos» debe coincidir a su vez con el número de etiquetas en el eje X.

Modificamos el fichero prueba.jsp para mostrar un texto que indicará el valor pulsado sobre la gráfica y la propia gráfica:

 

También debemos añadir el nuevo bean manejado dentro del fichero «faces-config.xml».

 

Compilamos y publicamos nuestros cambios, y arrancamos de nuevo el servidor. El resultado será una gráfica como la siguiente:

Gráfica personalizada

Si pulsamos sobre un elemento de la gráfica, veremos que se actualiza el texto de la parte superior:

Mensaje actualizado

06. Conclusiones

Las conclusiones que podemos extraer de este tutorial son las siguientes:

  • Podemos utilizar el componente outputChart para crear gráficas de forma rápida y sencilla en nuestras páginas JSF.
  • El componente outputChart dispone de bastantes propiedades que nos permiten configurar los datos y la apariencia de las gráficas a mostrar.
  • Podemos manejar los eventos que se producen al pulsar sobre los elementos de nuestras gráficas para realizar acciones, como mostrar información ampliada, abrir otras páginas o cualquier cosa que se nos ocurra.
  • Si necesitamos gráficas más sofisticadas, podemos utilizar el API de JCharts para crearlas y enlazarlas a componentes outputChart para obtener todas las ventajas que nos ofrecen JSF e ICEfaces.

Y eso es todo. Desde Autentia os animamos a utilizar este componente si necesitáis utilizar gráficas en vuestras aplicaciones, lo cual mejorará notablemente la presentación y permitirá tener un interfaz más intuitivo y amigable para los usuarios.

Dejar respuesta

Please enter your comment!
Please enter your name here