API de programación en javascript

Introducción

Ingrid ofrece una capa de programación para diversos propósitos:

  • Ejecutar programas personalizados para hacer herramientas e informes de la aplicación
  • Programar eventos que cambian el comportamiento de las clases y campos
  • Conectar aplicaciones externas a los webservices que ofrece el servidor de Ingrid, como por ejemplo, envío de correos electrónicos...

Los centenares de funciones que se ofrecen, están en dos niveles:

API de funciones Javascript de capa Ingrid (nivel aplicación, el más alto nivel)

API de funciones Javascript de capa Ingra (plataforma base, funciones de propósito más general)

Catálogo de informes y procedimientos incluidos con la aplicación. Dan una idea de los resultados que se pueden obtener con los informes personalizados..

Notación en la documentación del API

 Por debajo de la capa de funciones y objetos de aplicación y base de datos (INGRID) se encuentra una capa de funciones de propósito general (INGRA) sin relación con BD (matemáticas, cadenas de caracteres, interface...)

Estas funciones de INGRID se aplican todas sobre un objeto bas, la instancia de base de datos mongoDb accesible desde el programa javascript cliente.

Todas estas funciones son asíncronas, por lo que el último parámetro es una función de callback. El parámetro 'op' es variable, incluir un objeto con distintas variables, pero es OPCIONAL, no hay que dejarlo vacío, simplemente no ponerlo cuando no se especifica.

En la descripción de cada función, los valores indicados son los de defecto.

Todas pueden devolver un objeto con la variable 'error' y además las variables que se especifiquen.

Las funciones con formato ingrid.<clase>.<verbo>, como por ejemplo, ingrid.esp.montaEspacios (bas, binl, op, cb), se refieren a una clase concreta y no se documentan   porque son cientos en toda la aplicación, y además ampliables por el   usuario.

Ambos conjuntos de funciones se pueden usar desde los conceptos de clase procedimiento.

API de Google Charts

Documentación de referencia del API Javascript para gráficas estadísticas, por tipo de gráficas u objetos, en archivos PDF independientes:

API overview
Chart image API
Pie charts
Bar charts
Line charts
Map charts
Compound charts
Dynamic icons
Google-o-meters charts
Graphviz chrts
Radar charts
Scatter charts
Venn charts