StreetViewPanorama class
google.maps.StreetViewPanorama
class
Displays the panorama for a given LatLng
or panorama ID. A StreetViewPanorama
object provides a Street View "viewer" which can be stand-alone within a separate <div>
or bound to a Map
.
This class extends
MVCObject
.
Access by calling const {StreetViewPanorama} = await google.maps.importLibrary("streetView")
.
See Libraries in the Maps JavaScript API.
Constructor | |
---|---|
StreetViewPanorama |
StreetViewPanorama(container[, opts]) Parameters:
Creates a panorama with the passed StreetViewPanoramaOptions . |
Properties | |
---|---|
controls |
Type:
Array<MVCArray<HTMLElement>> Additional controls to attach to the panorama. To add a control to the panorama, add the control's <div> to the MVCArray corresponding to the ControlPosition where it should be rendered. |
Methods | |
---|---|
focus |
focus() Parameters: None
Return Value: None
Sets focus on this StreetViewPanorama . You may wish to consider using this method along with a visible_changed event to make sure that StreetViewPanorama is visible before setting focus on it. A StreetViewPanorama that is not visible cannot be focused. |
getLinks |
getLinks() Parameters: None
Return Value:
Array<StreetViewLink> Returns the set of navigation links for the Street View panorama. |
getLocation |
getLocation() Parameters: None
Return Value:
StreetViewLocation Returns the StreetViewLocation of the current panorama. |
getMotionTracking |
getMotionTracking() Parameters: None
Return Value:
boolean Returns the state of motion tracker. If true when the user physically moves the device and the browser supports it, the Street View Panorama tracks the physical movements. |
getPano |
getPano() Parameters: None
Return Value:
string Returns the current panorama ID for the Street View panorama. This id is stable within the browser's current session only. |
getPhotographerPov |
getPhotographerPov() Parameters: None
Return Value:
StreetViewPov Returns the heading and pitch of the photographer when this panorama was taken. For Street View panoramas on the road, this also reveals in which direction the car was travelling. This data is available after the pano_changed event. |
getPosition |
getPosition() Parameters: None
Return Value:
LatLng|null Returns the current LatLng position for the Street View panorama. |
getPov |
getPov() Parameters: None
Return Value:
StreetViewPov Returns the current point of view for the Street View panorama. |
getStatus |
getStatus() Parameters: None
Return Value:
StreetViewStatus Returns the status of the panorama on completion of the setPosition() or setPano() request. |
getVisible |
getVisible() Parameters: None
Return Value:
boolean Returns true if the panorama is visible. It does not specify whether Street View imagery is available at the specified position. |
getZoom |
getZoom() Parameters: None
Return Value:
number Returns the zoom level of the panorama. Fully zoomed-out is level 0, where the field of view is 180 degrees. Zooming in increases the zoom level. |
registerPanoProvider |
registerPanoProvider(provider[, opt_options]) Parameters:
Return Value: None
Set the custom panorama provider called on pano change to load custom panoramas. |
setLinks |
setLinks(links) Parameters:
Return Value: None
Sets the set of navigation links for the Street View panorama. |
setMotionTracking |
setMotionTracking(motionTracking) Parameters:
Return Value: None
Sets the state of motion tracker. If true when the user physically moves the device and the browser supports it, the Street View Panorama tracks the physical movements. |
setOptions |
setOptions(options) Parameters:
Return Value: None
Sets a collection of key-value pairs. |
setPano |
setPano(pano) Parameters:
Return Value: None
Sets the current panorama ID for the Street View panorama. |
setPosition |
setPosition(latLng) Parameters:
Return Value: None
Sets the current LatLng position for the Street View panorama. |
setPov |
setPov(pov) Parameters:
Return Value: None
Sets the point of view for the Street View panorama. |
setVisible |
setVisible(flag) Parameters:
Return Value: None
Sets to true to make the panorama visible. If set to false , the panorama will be hidden whether it is embedded in the map or in its own <div> . |
setZoom |
setZoom(zoom) Parameters:
Return Value: None
Sets the zoom level of the panorama. Fully zoomed-out is level 0, where the field of view is 180 degrees. Zooming in increases the zoom level. |
Inherited:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Events | |
---|---|
closeclick |
function(event) Arguments:
This event is fired when the close button is clicked. |
pano_changed |
function() Arguments: None
This event is fired when the panorama's pano id changes. The pano may change as the user navigates through the panorama or the position is manually set. Note that not all position changes trigger a pano_changed . |
position_changed |
function() Arguments: None
This event is fired when the panorama's position changes. The position changes as the user navigates through the panorama or the position is set manually. |
pov_changed |
function() Arguments: None
This event is fired when the panorama's point-of-view changes. The point of view changes as the pitch, zoom, or heading changes. |
resize |
function() Arguments: None
Developers should trigger this event on the panorama when its div changes size: google.maps.event.trigger(panorama, 'resize') . |
status_changed |
function() Arguments: None
This event is fired after every panorama lookup by id or location, via setPosition() or setPano() . |
visible_changed |
function() Arguments: None
This event is fired when the panorama's visibility changes. The visibility is changed when the Pegman is dragged onto the map, the close button is clicked, or setVisible() is called. |
zoom_changed |
function() Arguments: None
This event is fired when the panorama's zoom level changes. |
StreetViewPanoramaOptions interface
google.maps.StreetViewPanoramaOptions
interface
Options defining the properties of a StreetViewPanorama
object.
Properties | |
---|---|
addressControl optional |
Type:
boolean optional The enabled/disabled state of the address control. |
addressControlOptions optional |
Type:
StreetViewAddressControlOptions optional The display options for the address control. |
clickToGo optional |
Type:
boolean optional Default:
true The enabled/disabled state of click-to-go. Not applicable to custom panoramas. |
controlSize optional |
Type:
number optional Size in pixels of the controls appearing on the panorama. This value must be supplied directly when creating the Panorama, updating this value later may bring the controls into an undefined state. Only governs the controls made by the Maps API itself. Does not scale developer created custom controls. |
|