Recent Changes

This is documentation of an archived release.
For documentation on the current version, please check Knowledge Base.

Class orbit.webclient.Panorama

Class Summary

Constructor Attributes	Constructor Name and Description
	`orbit.webclient.Panorama(The)` Class Panorama models the group of PanoramaViewer instances.

Method Summary

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

removeEventListener

Remove an event listener.

Parameters

`{String}` eventType	The type of the event.
`{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}` resultHandler	The function to call when results arrive (optional). This function must take one argument : an array of PhotoPosition objects (can may be empty).
`{Function}` faultHandler	The function to call when a failure occurs (optional). This function must take one argument : a 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}` resultHandler	The function to call when results arrive. This function must take one argument : an array of PhotoPosition objects (can may be empty).
`{Function}` faultHandler	The function to call when a failure occurs. This function must take one argument : a 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 Panorama Measure Modes).

stopMeasuring

Stop measuring.

Last modified:: 2019/03/25 11:36