Panorama
Extends IPanorama.
Object describing the panorama.
See panorama.locate
Methods
Name | Returns | Description |
---|---|---|
createPlayer(element[, options]) | Creates a new instance of the panorama.Player class and opens the panorama in it. | |
getAngularBBox() | Number[] | Returns spherical coordinates that define the area covered by the image on the panoramic sphere. Coordinates are specified in the format Inherited from IPanorama. |
getConnectionArrows() | Returns array of connection arrows on the panorama. Inherited from IPanorama. | |
getConnectionMarkers() | Returns array of connection markers on the panorama. Inherited from IPanorama. | |
getCoordSystem() | Returns the coordinate system that is used for defining positions of the panorama and all the associated markers and connections. Inherited from IPanorama. | |
getDefaultDirection() | Number[] | Returns default direction of view. It will be used by the player when opening the panorama. Inherited from IPanorama. |
getDefaultSpan() | Number[] | Returns default size of the viewing area. It will be used by the player when opening the panorama. Inherited from IPanorama. |
getGraph() | IPanoramaGraph|null | Returns the graph of panoramas connected to the current panorama for making quick transitions. Inherited from IPanorama. |
getLayer() | String | Returns the layer the panorama belongs to. |
getMarkers() | Returns array of markers on the panorama. Inherited from IPanorama. | |
getName() | String | Returns the name of the panorama displayed by the player in the interface. Inherited from IPanorama. |
getPosition() | Number[] | Returns the location of the panorama in the coordinate system set in the options. Set in the format Inherited from IPanorama. |
getTileLevels() | Returns array of zoom levels for the panorama image. Inherited from IPanorama. | |
getTileSize() | Number[] | Returns the size of tiles that the panorama image is divided into. Inherited from IPanorama. |
Name | Returns | Description |
---|---|---|
createPlayer(element[, options]) | Creates a new instance of the panorama.Player class and opens the panorama in it. | |
getAngularBBox() | Number[] | Returns spherical coordinates that define the area covered by the image on the panoramic sphere. Coordinates are specified in the format Inherited from IPanorama. |
getConnectionArrows() | Returns array of connection arrows on the panorama. Inherited from IPanorama. | |
getConnectionMarkers() | Returns array of connection markers on the panorama. Inherited from IPanorama. | |
getCoordSystem() | Returns the coordinate system that is used for defining positions of the panorama and all the associated markers and connections. Inherited from IPanorama. | |
getDefaultDirection() | Number[] | Returns default direction of view. It will be used by the player when opening the panorama. Inherited from IPanorama. |
getDefaultSpan() | Number[] | Returns default size of the viewing area. It will be used by the player when opening the panorama. Inherited from IPanorama. |
getGraph() | IPanoramaGraph|null | Returns the graph of panoramas connected to the current panorama for making quick transitions. Inherited from IPanorama. |
getLayer() | String | Returns the layer the panorama belongs to. |
getMarkers() | Returns array of markers on the panorama. Inherited from IPanorama. | |
getName() | String | Returns the name of the panorama displayed by the player in the interface. Inherited from IPanorama. |
getPosition() | Number[] | Returns the location of the panorama in the coordinate system set in the options. Set in the format Inherited from IPanorama. |
getTileLevels() | Returns array of zoom levels for the panorama image. Inherited from IPanorama. | |
getTileSize() | Number[] | Returns the size of tiles that the panorama image is divided into. Inherited from IPanorama. |
Methods details
createPlayer
{vow.Promise} createPlayer(element[, options])
Creates a new instance of the panorama.Player class and opens the panorama in it.
Returns a promise object that will be resolved by the instance of the class panorama.Player with the current panorama open.
Parameters:
Parameter | Default value | Description |
---|---|---|
element * | — | Type: HTMLElement|String A reference to the HTML element that will contain the player, or the ID of this HTML element. |
options | — | Type: Object Options. |
options.direction | 'auto' | Type: Number[]|String Direction of view in the format |
options.span | 'auto' | Type: Number[]|String The angular dimensions of the field of view in the format |
Parameter | Default value | Description |
---|---|---|
element * | — | Type: HTMLElement|String A reference to the HTML element that will contain the player, or the ID of this HTML element. |
options | — | Type: Object Options. |
options.direction | 'auto' | Type: Number[]|String Direction of view in the format |
options.span | 'auto' | Type: Number[]|String The angular dimensions of the field of view in the format |
* Mandatory parameter/option.
getLayer
{String} getLayer()
See panorama.locate
Returns the layer the panorama belongs to.