Sun and moon widgets

From SpinetiX Support Wiki

Jump to: navigation, search

Description

Icon sun moon times widgets.png

The sun times widgets display informational content related to the sun movement, or, in the case of the sun times playlist widget, user-defined content that is triggered accordingly to key times of the sun movement (e.g., sunrise, sunset).

The moon times widget displays informational content related to the moon movement and phases.

Built-in widgets

Sun & moon widgets

Under the "Sun & Moon" folder of Elementi 2015 Library, you can find five ready-to-use widgets:

Further details about how to configure them can be found below.

Sun Times

This widget displays the sunrise & sunset times and the day length for the selected date. The information is automatically refreshed according to the selected date value.

The widget properties are detailed below.

Sun Times Table

This widget is a variant of the Sun Times widget, displaying the information for several days from the selected date. The information is automatically refreshed according to the selected date value.

Most of widget properties are detailed below, except for

  • Number of days
    Enter the number of days from the selected date to be included into the table.

The properties particular to this widget are grouped under "Formatting":

  • Layout
    Select between a horizontal layout and a vertical one.
  • Labels
    Enter a list of labels, separated by comma, to be used for table header; the label is displayed only if the corresponding time was selected.
  • Label format
    Configure how the label is displayed. See more details below.
  • Date format
    Configure how the date is displayed. See more details below.
  • Time format
    Configure how the time is displayed. See more details below.
  • Day length format
    Configure how the day length data is displayed. See more details below.
  • Trend format
    Configure how the trend data is displayed. See more details below.
  • Show solar noon
    Select whether the solar noon times are displayed within the table.
  • Show day length
    Select whether the day length data are displayed.
  • Show trend
    Select whether the trend data are displayed.

Sun Times Playlist

This widget displays user-defined content that is triggered according to sunrise and sunset times (calculated automatically for each day).

To configure the playlist content, go to "Slides" tab and add one or more layers (can be text, media or streaming) and, for each, select the starting time (sunrise, solar noon or sunset) and, optionally, enter a delay (in minutes) from the starting time.

From the "Properties" tab, you can select the default media to be played whenever there's no valid slide defined and the transition to be applied when switching from one slide to another. The rest of the widget properties are detailed below.

Sun Times Graph

Sun Times Graph

This widget displays a graph with the distribution of sunlight and the day length for the selected date. The time of day is displayed at the bottom of the graph and the legend includes the code colors for the different night and day phases. The information is automatically refreshed according to the selected date value.

Most of widget properties are detailed below; the ones particular to this widget are grouped under "Graph":

Moon Times

This widget displays informations about the moon rise & set times, illumination percent, current moon phase and about the major moon phases for the selected date. The information is automatically refreshed according to the selected date value.

Most of widget properties are detailed below; the ones particular to this widget are the following:

  • Moon
    These properties refer to the moon graphic, which can be a user media or automatically drawn.
    • Color
      Select the color to fill the moon shape.
    • Invert shape
      Select whether the moon shape should be inverted (useful for southern hemisphere).
    • Media
      Drag & drop a custom media to be displayed. Keep the special notation "[[moon]]" for automatic draw or leave it empty for no graphic.
  • Tuning
    Optional properties for fine-tuning the calculation results.
    • Moonrise offset (minutes)
      Enter the time offset (in minutes) to be applied to the moonrise time.
    • Moonset offset (minutes)
      Enter the time offset (in minutes) to be applied to the moonset time.

Configuration

The following properties are more or less common to all the sun & moon widgets:

  • Date / From
    The relative date for which to do the calculation. Select one of the available options (e.g., Today, Tomorrow, This Friday, Next Monday etc.) or manually enter the number of days (e.g., 1 day, +10 days, -4 days etc.).
  • Time zone
    Select the time zone used to display the results. Note that the times are calculated according to the local time zone; in case the selected coordinates correspond to different time zone, the times are for the local time zone (if you want them in the time zone of the location itself, make sure to select the location time zone).
  • Locale
    Select the locale used to format the date and times.
  • Coordinates
    Enter the geographic latitude and longitude coordinates of the location for which to do the calculation. Different coordinate formats are supported. See more about obtaining geographic coordinates.
  • Tuning
    Optional properties for fine-tuning the calculation results.
    • Elevation
      Enter a positive elevation (in meters) of the location relative to the surrounding areas. Can be useful when the location is on the top of a hill for instance.
    • Sunrise offset (minutes)
      Enter the time offset (in minutes) to be applied to the sunrise time.
    • Sunset offset (minutes)
      Enter the time offset (in minutes) to be applied to the sunset time.

Layout

In order to integrate the calculated data into the widget layout, a special notation using a double-pair of square brackets is employed, for instance [[date]], [[sunrise]], [[sunset]] etc. When the widget is running, each instance of [[item]] is replaced by the actual data returned upon the calculation.

  • It is possible to format dates, times and numbers according to the selected locale, using a combined notation like [[item>format]], where the format is specified using the special date/time patterns or number patterns.
  • Any visual formatting (font, color etc.) must be applied on the entire placeholder, including the square brackets.

Note Note: When needed, the size of the widget can be modified from the Document Properties dialog, in order to improve the content aspect or make space for other content. Note that playlist widgets occupy all the available space.

Sun and moon widgets for Elementi 3.x

Specification


Description

To use sun & moon widgets within Elementi 3.x, download any of the widgets on the right and drag & drop the 7-zip file into your Elementi project.

These widgets are using the jSignage.Astronomy.js library (included into the widget 7z file) for the necessary calculations.


Configuration

For more details about how to configure these widgets, see the corresponding sections above - the only exception is the "Sun Times Graph" which contains more properties grouped under "Graph":

  • Header
    Configure the header text layer. By default, this displays the selected date. For more details about this, see the Layout section above.
  • Text
    Configure the text displayed on the graph. By default, this displays the day length. For more details about this, see the Layout section above.
  • Day / Night label
    Enter the label used for day / night phase.
  • Day / Night color
    Select the color used for day / night phase.
  • Gauge attributes
    This advanced option allows altering the gauge graph attributes. For more details about this, see $.Graph.stackedHorizontalBarGauge() function.
  • Text attributes
    This advanced option allows altering the text attribute of the gauge. For more details about this, see linear gauge text attribute.

More widgets

Sun Times Graph Extended

Sun Times Graph Extended
Version 1.0 (2015-12-15)
Sun Times Graph Extended

Specification

  • Category: Time
  • Author: SpinetiX S.A.
  • License: GPL Version 3
  • Target: Elementi

Description

This widget displays a graph with the distribution of sunlight and the day length for the selected date. It is very similar to the Sun Times Graph widget, except that the legend includes the precise start and end times for night and day phases (based on the sunrise and sunset times).

Note Note: To use this widget within Elementi 3.x, make sure to download the jSignage.Astronomy.js library and import in the same folder as this widget.

Retrieved from "https://support.spinetix.com/w/index.php?title=Sun_and_moon_widgets&oldid=10587"
This page was last modified on 15 December 2015, at 18:30.