Prayer times widgets
From SpinetiX Support Wiki
Description
The prayer times widgets display informational content that is calculated based on the sun movement, or user-defined content that is triggered accordingly to key times of the sun movement (e.g., sunrise, sunset).
To use any of these widgets, download the widget and drag & drop the 7-zip file into your Elementi project. Further details about how to configure them can be found below.
These widgets are using the jSignage.Astronomy.js library (included into the widget 7z file) for the necessary calculations.
Islamic prayer times widgets
Prayer Times
These two widgets display the Islamic prayer times (Fajr, Dhuhr, Asr, Maghrib and Isha), along with the sunrise, sunset and midnight times, for the selected date. Salat widget is the Arabic version of the Prayer Times widget.
The information is automatically refreshed according to the selected date value. The prayer times calculation is done taking into account the values set within the widget properties, which are detailed below.
Prayer Times Playlist
These two widgets display user-defined content that is triggered according to the selected predefined times (calculated automatically for each day). Salat Playlist widget is the Arabic version of the Prayer Times Playlist widget.
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 (Fajr, sunrise, Asr, sunset, Isha etc.) and, optionally, enter a delay (in minutes) from the selected 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.
Prayer Times Table
These two widgets are variants of the Prayer Times widget, displaying the information for several days from the selected date. The information is automatically refreshed according to the selected date value.
Salat Table widget is the Arabic version of the Prayer Times Table widget.
Most of widget properties are detailed below; the ones 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.
- Show Imsak
- Select whether the Imsak times are displayed.
- Show sunset
- Select whether the sunset times are displayed.
- Show midnight
- Select whether the midnight times are displayed.
Configuration
The following properties are more or less common to all the prayer time 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.).
- Number of days
- Enter the number of days from the selected date to be included into the table. Available only for table widgets.
- 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.
- Calculation
- These properties determine how the prayer times calculation is done.
- Method
- Select the method / convention for calculating prayer times between: "Muslim World League", "Islamic Society of North America (ISNA)", "Egyptian General Authority of Survey", "Umm Al-Qura University, Makka" (default), "University of Islamic Sciences, Karachi" , "Institute of Geophysics, University of Tehran", and "Shia Ithna-Ashari (Ja`fari)".
- Imsak time (minutes before fajr)
- Enter the time offset (in minutes) before fajr to be used to calculate Imsak time.
- Dhuhr time (minutes after midday)
- Enter the time offset (in minutes) after midday to be used to calculate Dhuhr time.
- Maghrib time (minutes after sunset)
- Enter the time offset (in minutes) after sunset to be used to calculate Maghrib time.
- Asr juristic method
- Select the method for calculating asr time, between "Standard" (default) and "Hanafi".
- Higher latitudes
- Select the method to be used in case of higher latitudes, between: "No adjustments", "Middle of the night method", "1/7th of the night method", and "Angle-based method (recommended)" (default).
- Method
- These properties determine how the prayer times calculation is done.
- 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.
- Imsak offset (minutes)
- Enter the time offset (in minutes) to be applied to the Imsak time.
- Fajr offset (minutes)
- Enter the time offset (in minutes) to be applied to the Fajr time.
- Sunrise offset (minutes)
- Enter the time offset (in minutes) to be applied to the sunrise time.
- Dhuhr offset (minutes)
- Enter the time offset (in minutes) to be applied to the Dhuhr time.
- Asr offset (minutes)
- Enter the time offset (in minutes) to be applied to the Asr time.
- Sunset offset (minutes)
- Enter the time offset (in minutes) to be applied to the sunset time.
- Maghrib offset (minutes)
- Enter the time offset (in minutes) to be applied to the Maghrib time.
- Isha offset (minutes)
- Enter the time offset (in minutes) to be applied to the Isha time.
- Midnight offset (minutes)
- Enter the time offset (in minutes) to be applied to the midnight time.
- Elevation
- Optional properties for fine-tuning the calculation results.
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: 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.