View: SunMoon

The SunMoon component displays the monthly sun and moon information for a single location, such as sunrise, sunset, moon phases and illumination.

Use our wizard to customize this view


The following configuration options are supported by this view:

Option Default Description
range.from MM/DD/YYYY (string) The starting date to display weather data for in the format MM/DD/YYYY. Since this is a monthly view, the first of the requested month is enforced (e.g. 6/1/2017). The default value is today's date resulting in the current month being displayed. undefined (string) optional - The ending date to display weather data for in the format MM/DD/YYYY. This value is typically only used if you want to display a different range other than a single month. If undefined, this value is automatically calculated for a single month using the range.from value
enabled true (boolean) Whether or not this view is enabled. If false then the view will not be rendered and it's required data will not be requested. This option is typically only applicable for views contained within a parent layout.
metric false (boolean) Whether or not to display units in metric. The method setUnits() can be used at runtime once a view has rendered to change the units currently displayed.
renderNoData true (boolean) Whether or not the view should be rendered if data was not returned or not available
request undefined (object) An object containing the default AerisWeather API request options to use for the views's data request where applicable. These parameters can also be overriden in the load(:params) method when rendering the view using the JavaScript method.


The following methods are supported by instances of this view (JavaScript method only):

enabled() [boolean] Whether or not the component is currently enabled. When false, the component will not be rendered and data required for the component will not be requested.
hide() Hides the component's DOM element.
isMetric() [boolean] Whether or not the component is currently displaying Metric units.
load(:object) Requests data required by the component and renders the result. For components that don't require remote data requests, this method will call render() immediately. An optional object of request parameters can be provided to use for the request.
params() [object] Returns the latest request parameters used when loading data.
refresh() Re-renders the component using the cached data that was previously loaded.
rendered() [boolean] Whether or not the component has rendered.
setMetric(:boolean) Convenience method for setUnits() to toggle Metric units, where true sets the component's units to Metric and false uses Imperial.
setUnits(:number) Updates the unit type being displayed by the component, where 0 is Imperial and 1 is Metric.
show() Shows the component's DOM element.
units() [number] The current unit type being displayed, where 0 is Imperial and 1 is Metric.


The following events are triggered by instances of this view (JavaScript method only):

change:units Triggered when the component's unit type has changed (e.g. metric or imperial).
load:done Triggered after the component's data has loaded but before rendering the component.
load:error Triggered when an error occurs while requesting the component's data.
load:start Triggered immediately before the component's data request begins loading.
render Alias for render:after.
render:after Triggered after the component has rendered and any additional DOM elements and/or events have been setup as needed for the component.
render:before Triggered immediately before the component is rendered, allowing you to access and modify the data used in the template before getting rendered.


Use the following examples to assist with getting started using this view. Select your WeatherBlox integration method for example code specific to that usage.

API via Package

The first example below can be pasted into the body of your HTML document. For each additional snippet, you can replace the snippet within the first example which is located between the JavaScript comments.

Display the sun and moon data for the active month in Boulder, CO:

<link href="" rel="stylesheet"/>
<script src=""></script>

<!-- DOM target where the WeatherBlox view will be rendered -->
<div id="wxblox"></div>

const aeris = new AerisWeather('CLIENT_KEY', 'CLIENT_SECRET');
aeris.on('ready', () => {
	// Insert view / layout code below

var view = new aeris.wxblox.views.SunMoon('#wxblox');
p: 'boulder,co'

// End view / layout code }); </script>

Display the sun and moon data for the active month in Boulder, CO:

$view = new Aeris\WxBlox\View(‘views/sunmoon’, ‘boulder,co’);
$content = $view->html();
echo $content;

Display the sun and moon data for the active month in Boulder, CO:[api_key]/[secret_key]/views/calendar/boulder,co?

Last modified: March 12, 2020