Class that describes a request for a subset of photos.
A PhotoRequest defines a "result set". Given constraints on what photos we want to seach for (for example, all photos in group "Snow") the result set is the ordered list of photos that satisfy the constraint. Throughout the WAPI, photos obtained as a result of a request are referenced through their position in the result set, also called their "index". That is, photo at position 5 in the result set for the query "popular photos" will be the 5th most popular photo. This is to be distinguished from

• the Panoramio photo id of that photo
• the position of that photo in a particular HTTP request for photo metadata (for example, if we already have metadata for photos in positions 0, 1, 2, and 3 in the result set, then we may later ask for metadata for photos in positions 4, 5, 6 and 7 in the result set, but the photo in position 5 in the result set will occupy position 2 in that particular HTTP request).

A record to hold options for a PhotoRequest.
We define this mainly as a documentation tool, so we can clearly define what fields such option records have. We don't expect users to actually build objects of this class and pass them to PhotoRequest objects.

'ids': [{'userId': 187, 'photoId': 1000},
        {'userId': 1, 'photoId': 31444256},
        {'userId', 1, 'photoId': 30880260}}]

Constants for photo sorting options.

Constants for names of Panoramio photo sets.

Exception class for invalid request types.

Returns:

{string} Textual form of this exception.

Parent class for all widgets.
Currently, this class has two purposes:

• defines a parent type that can be used in type signatures when any widget is needed, and
• defines code that is shared by the PhotoWidget and the PhotoListWidget.

Parameters:

{boolean} enable

Whether to enable (if true) or disable (if false) the "next" or right/down-pointing arrow.

Parameters:

{boolean} enable

Whether to enable (if true) or disable (if false) the "previous" or left/up-pointing arrow.

Returns:

{?boolean} Whether we are at the end of the result set, and therefore cannot move forwards. Returns 'null' if a request has not yet been defined, or we have not moved into it.

Returns:

{?boolean} Whether we are at the beginning of the result set, and therefore cannot move backwards. Returns 'null' if a request has not yet been defined, or we have not moved into it.

A widget that shows one photo at a time.
The 'setPosition' method needs to be called for the widget to start displaying anything. This lets the user install handlers for the PHOTO_CHANGED event after the widget is constructed but before the event is raised.
This extends panoramio.Widget.

Returns:

{?panoramio.Photo} The currently displayed photo or 'null' if the widget is not fully initialized or the request is not defined. Note that only after the panoramio.events.EventType.PHOTO_CHANGED event has been raised will this return the new photo.

Returns:

{?number} The current position in the result set (the first photo is in position 0) or 'null' if the widget is not fully initialized. Note that only after the panoramio.events.EventType.PHOTO_CHANGED event has been raised will this return the new position.

Parameters:

{number} index

Index of the photo to show; the first photo in the result set is the 0th.

Parameters:

{panoramio.PhotoRequest|panoramio.PhotoRequestOptions|null} photoRequest

New request options or request object to use as a source of photos for this widget, or 'null' if the widget should be shown empty. If a panoramio.PhotoRequest object is used, the results will be shared among all widgets that use that object; if a panoramio.PhotoRequestOptions record is used, a separate request will be made for each widget.

Throws:

{panoramio.InvalidPhotoRequestError}

If 'photoRequestOptions' does not describe a valid request.

A record to hold options for a PhotoWidget.
We define this mainly as a documentation tool, so we can clearly define what fields such option records have. We don't expect users to actually build objects of this class and pass them to PhotoWidget objects.

A widget that shows multiple photos at a time.
The 'setPosition' method needs to be called for the widget to start displaying anything. This lets the user install handlers for the PHOTO_CHANGED event after the widget is constructed but before the event is raised.
A photo list widget contains several "slots" arranged in a grid. Each slot displays a photo (or is empty). Slots are numbered from 0 to (rows * columns - 1). The 0th slot is in the upper-left corner. In a horizontally-scrolling widget, the slots are ordered from top to bottom in the inner loop, and from left to right in the outer loop; in a vertically-scrolling widget, left-to-right in the inner loop and top-to-bottom in the outer loop. Each slot has a position in the result set, and displays the photo at that position. The slots' positions increase as the slot number. The widget's "position" is the position of its 0th slot.
This extends panoramio.Widget.

Returns:

{Array.<?panoramio.Photo>} For each slot in the widget, the photo displayed in that slot, or 'null' if no photo is shown at that slot (for example because the widget is not fully initialized, or because the slot's position in the result set is out of range). Note that only after the panoramio.events.EventType.PHOTO_CHANGED event has been raised will this return the new photos.

Returns:

{?number} Position of the widget in the photo set. For this multi-photo widget, the position is that of the photo shown in the first slot (at the upper-left corner) except that it is possible for this to be a negative number if we start showing results at a later slot and the first few slots are blank. It will be 'null' if the widget is not fully initialized. Note that only after the panoramio.events.EventType.PHOTO_CHANGED event has been raised will this return the new position.

Parameters:

{number} index

Position in the result set of the new photo to show in the first slot (the upper-left corner). All other slots are updated accordingly. This number may be out of range of the result set and still some photos may be displayed in later slots.

Parameters:

{panoramio.PhotoRequest|panoramio.PhotoRequestOptions|null} photoRequest

New request options or request object to use as a source of photos for this widget, or 'null' if the widget should be shown empty. If a panoramio.PhotoRequest object is used, the results will be shared among all widgets that use that object; if a panoramio.PhotoRequestOptions record is used, a separate request will be made for each widget.

Throws:

{panoramio.InvalidPhotoRequestError}

If 'photoRequestOptions' does not describe a valid request.

A record to hold options for a PhotoListWidget.
We define this mainly as a documentation tool, so we can clearly define what fields such option records have. We don't expect users to actually build objects of this class and pass them to PhotoListWidget objects.

Constants for widget orientation.

Parameters:

event_target src

The node to listen to events on.

{string|Array.<string>} type

Event type or array of event types.

{function(event)|Object} listener

Callback method, or an object with a handleEvent function.

{boolean|undefined} opt_capt

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

{Object|undefined} opt_handler

Element in whose scope to call the listener.

Returns:

{?number} Unique key for the listener.

Parameters:

event_target src

The target to stop listening to events on.

{string|Array.<string>} type

The name of the event without the 'on' prefix.

{function(event)|Object} listener

The listener function or object to remove.

{boolean|undefined} opt_capt

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

{Object|undefined} opt_handler

Element in whose scope to call the listener.

Returns:

{?boolean} indicating whether the listener was there to remove.

Parameters:

{?number} key

The key returned by listen() for this event listener.

Returns:

{boolean} indicating whether the listener was there to remove.

Constants for event names.

Class for "a photo was clicked" event.
For such events, the target will be a widget object.

Returns:

{panoramio.Photo} The photo that was clicked.

Returns:

{?number} The position of the photo in the widget's result set, or 'null' if it cannot be determined.

Class that describes a Panoramio Photo. This is only metadata about the photo, i.e. available sizes, photo id, title, owner, ... but it does not include pixels.

Returns:

{?number} The natural height of this photo, in pixels, for the full size version, oriented as the photo is to be displayed.

Returns:

{?number} The Panoramio user id of the author of this photo.

Returns:

{string} The name of the author of this photo.

Returns:

{?string} The URL for the Panoramio user page for the author of this photo.

Returns:

{?number} The Panoramio photo id of this photo.

Returns:

{string} The title of this photo.

Returns:

{?string} The URL for the Panoramio photo page for this photo.

Returns:

{?panoramio.Coordinates} The position where the photo was taken, or 'null' if it is not known.

Returns:

{?number} The natural width of this photo, in pixels, for the full size version, oriented as the photo is to be displayed.

A record to hold a latitude-longitude pair.
We define this mainly as a documentation tool, so we can clearly define what fields such option records have. We don't expect users to actually build objects of this class.

Constants for photo cropping.

Styles for display of a ToS block.
This is the block shown next to a widget, which contains the Panoramio logo and the phrase "Photos provided by Panoramio are under the copyright of their owners".

A widget that just displays an attribution block.
This is made into a separate widget so that users can manually specify where the attribution block should be positioned, in case they want to.

Returns:

{number} The height of this widget, in pixels.

A record to hold options for an attribution Widget.
We define this mainly as a documentation tool, so we can clearly define what fields such option records have. We don't expect users to actually build objects of this class and pass them to PhotoWidget objects.

Exception class for violations of Terms of Service.

Returns:

{string} Textual form of this exception.