Versión: 2.8.3
El objeto TSExplorer contiene una one page application con un explorador de series de tiempo, que permite buscar y visualizar series de un catálogo de datos abiertos.
Está en el archivo llamado main.js y se aloja versionado en el CDN: https://cdn.jsdelivr.net/gh/datosgobar/series-tiempo-ar-explorer@2.8.3/dist/js/main.js
<script type='text/javascript' src='https://cdn.jsdelivr.net/gh/datosgobar/series-tiempo-ar-explorer@2.8.3/dist/js/main.js'></script>
<div id="explorer-container"></div>
TSExplorer.render('explorer-container', {
...
})
<html>
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/datosgobar/series-tiempo-ar-explorer@2.8.3/dist/js/main.js"></script>
<div id="explorer-container"></div>
<script>
window.onload = function() {
TSExplorer.render('explorer-container', {
featured: [
"103.1_I2N_2016_M_15",
"168.1_T_CAMBIOR_D_0_0_26",
],
seriesApiUri: "https://apis.datos.gob.ar/series/api",
catalogId: 'datosgobar',
formatChartUnits: true,
laps: {
Diaria: 90,
Mensual: 24,
Trimestral: 20,
Semestral: 10,
Anual: 10,
},
locale: 'AR'
})
}
</script>
</body>
</html>
| Nombre | Requerido | Descripción | Tipo | Default | Ejemplos |
|---|---|---|---|---|---|
| seriesApiUri | Si | URI a la API donde buscamos los datos. | string | Ninguno | https://apis.datos.gob.ar/series/api |
| featured | No | Indica los IDs de las series destacadas | string[] | [] | ["103.1_I2N_2016_M_15", "168.1_T_CAMBIOR_D_0_0_26"] |
| catalogId | No | Representa el id del catálogo de donde busca las series | string | Ninguno | datosgobar |
| formatChartUnits | No | Indica si debe formatear a porcentaje los valores entre -1 y 1. | boolean | true | true / false |
| laps | No | Información para traer los últimos _n_ valores de la serie, con _n_ igual al valor por frecuencia.
{Diaria: number, Mensual: number, Trimestral: number, Semestral: number, Anual: number} |
object | true | true / false |
| locale | No | Valores posibles: `"AR"` o `"US"` (pendientes nuevos valores). Representan qué _locale_ usar para formatear números, es decir, separadores de miles o de decimales. | string | "AR" | "AR" / "US" |
| maxDecimals | No | Cantidad máxima de cifras decimales a mostrar para los valores de las series, tanto en sus tarjetas destacadas, como resultados de búsqueda y notas (tooltips) de los gráficos. | int | 2 | 0/4/1 |
| heroImageUrl | No | URL de la imagen a mostrar de fondo en el banner del encabezado. | string | https://datos.gob.ar/images/hero_bg.svg | https://upload.wikimedia.org/wikipedia/commons/1/1a/Flag_of_Argentina.svg |
| numbersAbbreviate | No | Flag que indica si se deben abreviar los números grandes y formatearlos con el sufijo pertinente; si está apagado, no se realizará abreviatura alguna. Ver la sección de "Abreviatura" para más detalle. | boolean | true | false |
| decimalsBillion | No | Cantidad de dígitos decimales a mostrar en aquellos números que son abreviados y divididos por un billón. Puede ser mayor al parámetro maxDecimals. | int | 2 | 4 |
| decimalsMillion | No | Cantidad de dígitos decimales a mostrar en aquellos números que son abreviados y divididos por un millón. Puede ser mayor al parámetro maxDecimals. | boolean | 2 | 0 |
Si se habilita la abreviatura y formateo de números grandes, encendiendo el flag numbersAbbreviate (la única manera de apagarlo es seteándole explícitamente un valor false por medio del parámetro del componente), se procederá a formatearlos de la siguiente manera:
decimalsBillion y decimalsMillion (según corresponda).