Skip to content

Commit

Permalink
Document display_utc_times parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
oscarfonts committed Apr 11, 2017
1 parent 2b5ac05 commit 5489b56
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 24 deletions.
24 changes: 14 additions & 10 deletions doc/ca/widgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Els seus paràmetres obligatoris són:
Altres paràmetres opcionals:

* "Title": Si no s'especifica, per defecte es fa servir com a títol el nom de la Feature.
* "display_utc_times": Les dates del servei SOS s'obtenen en UTC, i per defecte es converteixen al fus horari local del navegador. Si es volen mostrar en UTC, posar aquest paràmetre a `true`.
* "Footnote": Text opcional que apareixerà com una petita nota al peu.
* "Custom_css_url": full d'estils css que s'aplicarà al widget.

Expand All @@ -34,6 +35,7 @@ Paràmetres obligatoris:
Paràmetres opcionals:

* "Footnote": Text opcional que apareixerà com una petita nota al peu.
* "display_utc_times": Les dades del servei SOS s'obtenen en UTC, i per defecte es converteixen al fus horari local del navegador. Si es volen mostrar en UTC, posar aquest paràmetre a `true`.
* "Custom_css_url": full d'estils css que s'aplicarà al widget.


Expand All @@ -53,6 +55,7 @@ Paràmetres obligatoris:
Paràmetres opcionals:

* "Footnote": Text opcional que apareixerà com una petita nota al peu.
* "display_utc_times": Les dades del servei SOS s'obtenen en UTC, i per defecte es converteixen al fus horari local del navegador. Si es volen mostrar en UTC, posar aquest paràmetre a `true`.
* "Custom_css_url": full d'estils css que s'aplicarà al widget. Tingueu en compte que l'aspecte de jqGrid ve determinat pel tema jQuery-ui subjacent.

.. note:: aquest widget depèn de jQuery, jQuery UI i el plugin jgGrid. És un widget bastant pesat i no gaire
Expand Down Expand Up @@ -182,7 +185,7 @@ Si s'està utilitzant el widget amb Javascript, és possible capturar el "click"
console.log(marker.feature);
}

Finalment, els paràmetres opcionals habituals "footnote" i "custom_css_url" també estan disponibles.
Finalment, els paràmetres opcionals habituals "display_utc_times", "footnote" i "custom_css_url" també estan disponibles.

Vegeu un **exemple funcional complet** aquí: http://bl.ocks.org/oscarfonts/265d734349396cf4372c

Expand All @@ -199,7 +202,7 @@ Els seus paràmetres obligatoris són:
* Una llista de "properties" a mostrar.
* El "refresh_interval", en segons.

I els paràmetres opcionals: "title", "footnote" i "custom_css_url".
I els paràmetres opcionals: "title", "display_utc_times", "footnote" i "custom_css_url".

El panell també mostrarà la data de les observacions com a subtítol. En el cas que algun dels valors sigui d'una data anterior a la data comú,
es mostrarà el valor en color vermell i es mostrarà la data per a aquesta observació en particular.
Expand All @@ -225,7 +228,7 @@ Paràmetres obligatoris:
* "min_value" i "max_value", que determinen els valors extrems.
* "refresh_interval" en segons.

I els paràmetres opcionals habituals: "footnote" i "custom_css_url".
I els paràmetres opcionals habituals: "display_utc_times", "footnote" i "custom_css_url".


Status (status)
Expand All @@ -240,7 +243,7 @@ Aquest widget està pensat com una eina de gestió (una espècie d'hiper-taula),

Els seus únics paràmetres obligatoris són "service" i "offering".

I els paràmetres opcionals habituals: "footnote" i "custom_css_url".
I els paràmetres opcionals habituals: "display_utc_times", "footnote" i "custom_css_url".


Taula (table)
Expand All @@ -257,7 +260,7 @@ Paràmetres:
* "time_start" i "time_end": Període de temps del que volem obtenir observacions.
* I el "title".

A més dels paràmetres opcionals comuns: "footnote" i "custom_css_url".
A més dels paràmetres opcionals comuns: "display_utc_times", "footnote" i "custom_css_url".


Termòmetre (thermometer)
Expand All @@ -275,8 +278,9 @@ Paràmetres obligatoris:

Altres paràmetres opcionals:

* "Footnote": Text opcional que apareixerà com una petita nota al peu.
* "Custom_css_url": full d'estils css que s'aplicarà al widget.
* "footnote": Text opcional que apareixerà com una petita nota al peu.
* "display_utc_times", per mostrar l'hora en temps universal i no en el fus horari local.
* "custom_css_url": full d'estils css que s'aplicarà al widget.


Sèrie temps (timechart)
Expand All @@ -299,7 +303,7 @@ Paràmetres opcionals:
* "colors": Array de colors en format `#rrggbb`, que s'aplicarà en dibuixar les línies de cadascuna de les properties.
* "callback": Funció que es crida després d'instanciar el widget. Recull la instància del Flot chart com a paràmetre.

A més dels paràmetres opcionals comuns: "footnote" i "custom_css_url".
A més dels paràmetres opcionals comuns: "display_utc_times", "footnote" i "custom_css_url".


Rosa vents (windrose)
Expand All @@ -322,8 +326,8 @@ Paràmetres obligatoris:

Paràmetres opcionals:

* "Subtitle".
* "Footnote" i "custom_css_url".
* "subtitle".
* "display_utc_times", "footnote" i "custom_css_url".

Així és com s'agrupen les dades per construïr la gràfica de la rosa dels vents:

Expand Down
18 changes: 11 additions & 7 deletions doc/en/widgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Mandatory inputs are:
Other optional inputs:

* "title": If not specified, defaults to the name of the Feature.
* "display_utc_times": The SOS service dates are in UTC, and they are converted to local time fuse by default. To display them in UTC, set this parameter to `true`.
* "footnote": Optional small text caption at the bottom.
* "custom_css_url": css stylesheet to be applied to the widget.

Expand All @@ -33,6 +34,7 @@ Mandatory inputs are:
Other optional inputs:

* "footnote": Optional small text caption at the bottom.
* "display_utc_times": The SOS service dates are in UTC, and they are converted to local time fuse by default. To display them in UTC, set this parameter to `true`.
* "custom_css_url": css stylesheet to be applied to the widget.


Expand All @@ -52,6 +54,7 @@ Mandatory inputs:
Other optional inputs:

* "footnote": Optional small text caption at the bottom.
* "display_utc_times": The SOS service dates are in UTC, and they are converted to local time fuse by default. To display them in UTC, set this parameter to `true`.
* "custom_css_url": css stylesheet to be applied to the widget. Please note that jqGrid look & feel is taken from the underlying jQuery-ui theme.

.. note:: this widget depends on jQuery, jQuery UI and the jgGrid plugin itself. It's a rather heavy and not much
Expand Down Expand Up @@ -183,7 +186,7 @@ If creating the widget with Javascript, it is possible to capture the "click" ev
console.log(marker.feature);
}

Finally, the common "footnote" and "custom_css_url" inputs are also available.
Finally, the common "display_utc_times", "footnote" and "custom_css_url" inputs are also available.

See a **complete live example** here: http://bl.ocks.org/oscarfonts/265d734349396cf4372c

Expand All @@ -200,7 +203,7 @@ Its mandatory inputs are:
* A list of "properties" to be displayed.
* The "refresh_interval", in seconds.

And the optional inputs: "title", "footnote" and "custom_css_url".
And the optional inputs: "title", "display_utc_times", "footnote" and "custom_css_url".

The panel will show the result time as a subtitle. In case some of the propertie's result time is previous to the common
one, the value will be displayed in red and the particular result time for that observation displayed explicitly.
Expand All @@ -225,7 +228,7 @@ Its mandatory inputs:
* "min_value" and "max_value", which will determine the extreme values.
* "refresh_interval" in seconds.

And the usual optional inputs: "footnote" and "custom_css_url".
And the usual optional inputs: "display_utc_times", "footnote" and "custom_css_url".


Status
Expand All @@ -239,7 +242,7 @@ This widget is meant as a monitoring tool (sort of hypertable), and it's better

Its only mandatory inputs are "service" and "offering".

And the common optional inputs: "footnote" and "custom_css_url".
And the common optional inputs: "display_utc_times", "footnote" and "custom_css_url".


Table
Expand All @@ -253,7 +256,7 @@ compact view than jqGrid widget. The widget is built as a plain HTML table suppo
* "time_start" and "time_end": The result time range of the observations to be displayed.
* The table's "title".

And the common optional inputs: "footnote" and "custom_css_url".
And the common optional inputs: "display_utc_times", "footnote" and "custom_css_url".


Thermometer
Expand All @@ -271,6 +274,7 @@ Mandatory inputs are:
Other optional inputs:

* "footnote": Optional small text caption at the bottom.
* "display_utc_times", to force times to be expressed in universal time and not in local fuse.
* "custom_css_url": css stylesheet to be applied to the widget.


Expand All @@ -287,7 +291,7 @@ Charts are built with the `Flot charting library <http://www.flotcharts.org/>`_,
* "time_start" and "time_end": Determines the time period of the observations to be displayed.
* The timechart's "title".

And the common optional inputs: "footnote" and "custom_css_url".
And the common optional inputs: "display_utc_times", "footnote" and "custom_css_url".

Windrose
========
Expand Down Expand Up @@ -315,7 +319,7 @@ Parámetros opcionales:
Optional inputs:

* "subtitle".
* "footnote" and "custom_css_url".
* "display_utc_times", "footnote" and "custom_css_url".

This is how data is grouped to build the windrose chart:

Expand Down
18 changes: 11 additions & 7 deletions doc/es/widgets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Sus parámetros obligatorios son:
Otros parámetros opcionales:

* "title": Si no se especifica, por defecto se usa como título el nombre de la Feature.
* "display_utc_times": Las fechas del servicio SOS se obtienen en UTC, y por defecto se convierten al huso horario local del navegador. Si se quieren mostrar en UTC, poner este parámetro a `true`.
* "footnote": Texto opcional que aparecerá como una pequeña nota al pie.
* "custom_css_url": hoja de estilos css que se aplicará al widget.

Expand All @@ -34,6 +35,7 @@ Parámetros obligatorios:
Parámetros opcionales:

* "footnote": Texto opcional que aparecerá como una pequeña nota al pie.
* "display_utc_times": Las fechas del servicio SOS se obtienen en UTC, y por defecto se convierten al huso horario local del navegador. Si se quieren mostrar en UTC, poner este parámetro a `true`.
* "custom_css_url": hoja de estilos css que se aplicará al widget.


Expand All @@ -53,6 +55,7 @@ Parámetros obligatorios:
Parámetros opcionales:

* "footnote": Texto opcional que aparecerá como una pequeña nota al pie.
* "display_utc_times": Las fechas del servicio SOS se obtienen en UTC, y por defecto se convierten al huso horario local del navegador. Si se quieren mostrar en UTC, poner este parámetro a `true`.
* "custom_css_url": hoja de estilos css que se aplicará al widget. Nótese que el aspecto de jqGrid se toma del tema jQuery-ui subyacente.

.. note:: este widget depende de jQuery, jQuery UI y el plugin jgGrid. Es un widget bastante pesado y no muy
Expand Down Expand Up @@ -183,7 +186,7 @@ Si se está usando el widget con Javascript, es posible capturar el "click" sobr
}


Por último, los parámetros opcionales habituales "footnote" y "custom_css_url" también están disponibles.
Por último, los parámetros opcionales habituales "display_utc_times", "footnote" y "custom_css_url" también están disponibles.

Véase un **ejemplo funcional completo** aquí: http://bl.ocks.org/oscarfonts/265d734349396cf4372c

Expand All @@ -200,7 +203,7 @@ Sus parámetros obligatorios son:
* Una lista de "properties" a mostrar.
* El "refresh_interval", en segundos.

Y los parámetros opcionales: "title", "footnote" y "custom_css_url".
Y los parámetros opcionales: "title", "display_utc_times", "footnote" y "custom_css_url".

El panel también mostrará la fecha de las observaciones como subtitulo. En caso de que alguno de los valores sea de una fecha anterior a la fecha común,
se mostará el valor en color rojo y se mostrará la fecha para dicha observación en particular.
Expand All @@ -226,7 +229,7 @@ Parámetros obligatorios:
* "min_value" y "max_value", que determinan los valores extremos.
* "refresh_interval" en segundos.

Y los parámetros opcionales habituales: "footnote" y "custom_css_url".
Y los parámetros opcionales habituales: "display_utc_times", "footnote" y "custom_css_url".


Status (status)
Expand All @@ -241,7 +244,7 @@ Este widget está pensado como una herramienta de supervisón (una especie de hi

Sus únicos parámetros obligatorios son "service" y "offering".

Y los parámetros opcionales habituales: "footnote" y "custom_css_url".
Y los parámetros opcionales habituales: "display_utc_times", "footnote" y "custom_css_url".


Tabla (table)
Expand All @@ -258,7 +261,7 @@ Parámetros:
* "time_start" y "time_end": Período de tiempo del que quieren obtenerse observaciones.
* Y el "title".

Además de los parámetros opcionales comunes: "footnote" y "custom_css_url".
Además de los parámetros opcionales comunes: "display_utc_times", "footnote" y "custom_css_url".


Termómetro (thermometer)
Expand All @@ -277,6 +280,7 @@ Parámetros obligatorios:
Otros parámetros opcionales:

* "footnote": Texto opcional que aparecerá como una pequeña nota al pie.
* "display_utc_times", para mostrar la hora en tiempo universal y no en el huso horario local.
* "custom_css_url": hoja de estilos css que se aplicará al widget.


Expand All @@ -300,7 +304,7 @@ Parámetros opcionales:
* "colors": Array de colores en formato `#rrggbb`, que se aplicarán al dibujar las líneas de cada una de las properties indicadas.
* "callback": Función que se llamará tras instanciar el widget. Recoge la instancia del Flot chart como parámetro.

Además de los parámetros opcionales comunes: "footnote" y "custom_css_url".
Además de los parámetros opcionales comunes: "display_utc_times", "footnote" y "custom_css_url".


Rosa vientos (windrose)
Expand All @@ -324,7 +328,7 @@ Parámetros obligatorios:
Parámetros opcionales:

* "subtitle".
* "footnote" y "custom_css_url".
* "display_utc_times", "footnote" y "custom_css_url".

Así es como se agrupan los datos para construír la gráfica de la rosa de los vientos:

Expand Down

0 comments on commit 5489b56

Please sign in to comment.