~~NOCACHE~~

======  Class orbit.webclient.Panorama ======

===== Class Summary =====
^ Constructor Attributes ^ Constructor Name and Description ^
|  | ''**[[orbit.webclient.Panorama#constructor|orbit.webclient.Panorama]]**(The)''\\ Class Panorama models the group of PanoramaViewer instances. |

===== Method Summary =====

^ Method Attributes ^ Method Name and Description ^
|  | ''**[[orbit.webclient.Panorama#addEventListener|addEventListener]]**(eventType, handler)''\\ Add an event listener. |
|  | ''**[[orbit.webclient.Panorama#closeViewer|closeViewer]]**(viewerId)''\\ Close a viewer. |
|  | ''**[[orbit.webclient.Panorama#findProjectLabelForPhoto|findProjectLabelForPhoto]]**(photo)''\\ Find the project label associated with a photo position. |
|  | ''**[[orbit.webclient.Panorama#getProjectLabelColor|getProjectLabelColor]]**(labelName)''\\ Get the color associated with a project label. |
|  | ''**[[orbit.webclient.Panorama#getProjectLabels|getProjectLabels]]**()''\\ Get the list of available project labels. |
|  | ''**[[orbit.webclient.Panorama#getProjectLabelUse|getProjectLabelUse]]**(layerName)''\\ Get if a project label is in use. |
|  | ''**[[orbit.webclient.Panorama#getSnapshotButtonVisible|getSnapshotButtonVisible]]**()''\\ Get the visibility of the 'snapshot-button-visible' setting. |
|  | ''**[[orbit.webclient.Panorama#getViewer|getViewer]]**(viewerId)''\\ Get a panorama viewer by its identifier. |
|  | ''**[[orbit.webclient.Panorama#getViewerIds|getViewerIds]]**()''\\ Get identifications of all currently opened viewers. |
|  | ''**[[orbit.webclient.Panorama#openViewer|openViewer]]**(photoObject, options)''\\ Open a new viewer. |
|  | ''**[[orbit.webclient.Panorama#openViewerAtLatLon|openViewerAtLatLon]]**(lat, lon, options)''\\ Open a panorama viewer and try to open a photo at the specified coordinates. |
|  | ''**[[orbit.webclient.Panorama#openViewerAtXY|openViewerAtXY]]**(x, y, crs, options)''\\ Open a panorama viewer and try to open a photo at the specified coordinate. |
|  | ''**[[orbit.webclient.Panorama#openViewerById|openViewerById]]**(imageId, options)''\\ Open a panorama viewer and try to open a photo with the specified ID. |
|  | ''**[[orbit.webclient.Panorama#removeEventListener|removeEventListener]]**(eventType, handler)''\\ Remove an event listener. |
|  | ''**[[orbit.webclient.Panorama#searchPhotoPositions|searchPhotoPositions]]**(minX, minY, maxX, maxY, crs, resultHandler, faultHandler)''\\ Search for photo locations. |
|  | ''**[[orbit.webclient.Panorama#searchPhotoPositionsNearby|searchPhotoPositionsNearby]]**(x, y, crs, distance, resultHandler, faultHandler)''\\ Search for photo locations. |
|  | ''**[[orbit.webclient.Panorama#setProjectLabelUse|setProjectLabelUse]]**(layerName, value)''\\ Set the usage of a project label. |
|  | ''**[[orbit.webclient.Panorama#setSnapshotButtonVisible|setSnapshotButtonVisible]]**(value)''\\ Set the visibility of the 'snapshot-button-visible' setting. |
|  | ''**[[orbit.webclient.Panorama#startMeasuring|startMeasuring]]**(mode)''\\ Start measuring. |
|  | ''**[[orbit.webclient.Panorama#stopMeasuring|stopMeasuring]]**()''\\ Stop measuring. |

===== Class Detail =====

'''' **orbit.webclient.Panorama**(The)\\ 
Class Panorama models the group of PanoramaViewer instances.

**Parameters**
| ''{goog.ui.media.FlashObject}''  **The**	 | parent flash object. |

===== Method Detail =====

====  addEventListener ====
					
Add an event listener.

**Parameters**
| ''{String}'' **eventType**  | The event type to listen to. |
| ''{[[Function|Function]]}'' **handler**  | The function to call when the event occurs. |

====  closeViewer ====
					
Close a viewer.

**Parameters**
| **viewerId**  | The identifier of the viewer to close. |

====  findProjectLabelForPhoto ====
					
Find the project label associated with a photo position.

**Parameters**
| **photo**  | the photo position. |

**Returns**

returns null if no associated project label was found for the given photo.

====  getProjectLabelColor ====
					
Get the color associated with a project label.

**Parameters**
| **labelName**  | the project label name. |

**Returns**

returns the color or NaN in case the project label was not found.

====  getProjectLabels ====
					
Get the list of available project labels.

**Returns**

returns the list of project label names.

====  getProjectLabelUse ====
					
Get if a project label is in use.

**Parameters**
| **layerName**  | name of the label to check. |

**Returns**

returns the usage of the given label.

====  getSnapshotButtonVisible ====
					
Get the visibility of the 'snapshot-button-visible' setting.

====  getViewer ====
					
Get a panorama viewer by its identifier.

**Parameters**
| ''{String}'' **viewerId**  | The viewer identifier. |

**Returns**

''{PanoramaViewer}'' Returns a panorama viewer.

====  getViewerIds ====
					
Get identifications of all currently opened viewers.

**Returns**

returns an array of strings where each string is a viewer identifier.

====  openViewer ====
					
Open a new viewer.

**Parameters**
| **photoObject**  | the photo object to load after opening the viewer (optional). |
| **options**  | the [[180:developer:webclient:load_photo_options|load-photo options]]. |

====  openViewerAtLatLon ====
					
Open a panorama viewer and try to open a photo at the specified coordinates.

**Parameters**
| **lat**  | The coordinate latitude. |
| **lon**  | The coordinate longitude. |
| **options**  | The set of [[180:developer:webclient:load_photo_options|load-photo options]]. |

====  openViewerAtXY ====
					
Open a panorama viewer and try to open a photo at the specified coordinate.

**Parameters**
| **x**  | The x coordinate ordinal. |
| **y**  | The y coordinate ordinal. |
| **crs**  | The crs of the coordinate. |
| **options**  | The set of [[180:developer:webclient:load_photo_options|load-photo options]]. |

====  openViewerById ====
					
Open a panorama viewer and try to open a photo with the specified ID.

**Parameters**
| **imageId**  | the image identifier. |
| **options**  | The set of [[180:developer:webclient:load_photo_options|load-photo options]]. |

====  removeEventListener ====
					
Remove an event listener.

**Parameters**
| ''{String}'' **eventType**  | The type of the event. |
| ''{[[Function|Function]]}'' **handler**  | The handler function. |
====  searchPhotoPositions ====
					
Search for photo locations.

**Parameters**
| ''{Number}'' **minX**  | The minimum X value. |
| ''{Number}'' **minY**  | The minimum Y value. |
| ''{Number}'' **maxX**  | The maximum X value. |
| ''{Number}'' **maxY**  | The maximum Y value. |
| ''{String}'' **crs**  | The CRS of the boundingbox coordinates. |
| ''{[[Function|Function]]}'' **resultHandler**  | The function to call when results arrive (optional).  This function must take one argument : an array of [[180:developer:webclient:core_types|PhotoPosition]] objects (can may be empty). |
| ''{[[Function|Function]]}'' **faultHandler**  | The function to call when a failure occurs (optional).  This function must take one argument : a [[180:developer:webclient:core_types|Fault]] object. |

====  searchPhotoPositionsNearby ====
					
Search for photo locations.

**Parameters**
| ''{Number}'' **x**  | The minimum X value. |
| ''{Number}'' **y**  | The minimum Y value. |
| ''{String}'' **crs**  | The CRS of the boundingbox coordinates. |
| ''{Number}'' **distance**  | The maximum distance (meters). |
| ''{[[Function|Function]]}'' **resultHandler**  | The function to call when results arrive.  This function must take one argument : an array of [[180:developer:webclient:core_types|PhotoPosition]] objects (can may be empty). |
| ''{[[Function|Function]]}'' **faultHandler**  | The function to call when a failure occurs.  This function must take one argument : a [[180:developer:webclient:core_types|Fault]] object. |

====  setProjectLabelUse ====
					
Set the usage of a project label.

**Parameters**
| **layerName**  | name of the label to check. |
| **value**  | the usage value to set. |

**Returns**

returns true if the label was found and updated.

====  setSnapshotButtonVisible ====
					
Set the visibility of the 'snapshot-button-visible' setting.

**Parameters**
| **value**  | the new value. |

====  startMeasuring ====
					
Start measuring.

**Parameters**
| **mode**  | {String} The measuring mode (see [[180:developer:webclient:panorama_measure_modes]]). |

====  stopMeasuring ====
					
Stop measuring.