Mapspace API Reference

Class: ViewerInfo

ViewerInfo

An action for a Mapspace.control.Label showing different information of viewer properties or status. Some of this information can be map rotation, resolution, zoom, mouse position, etc.

By default, mouse coordinates are in 'EPSG:4326', but can be in any supported projection.

new ViewerInfo( [options])

Parameters:
Name Type Argument Description
options Mapspace.action.ViewerInfoOptions <optional>

Options.
Source:
mapspace-global/actions/viewerinfo.js
Fires:
  • ol.Object.Event#event:change:projection

Extends

Members

<nullable> control :Mapspace.control.Control

The control this action is attached to.

Inherited From:
Source:
mapspace/actions/action.js

<nullable> viewer :Mapspace.Viewer

This is the viewer this action will be tied to.

Inherited From:
Source:
mapspace/actions/action.js

Methods

getProjection()

Return the projection that is used to report the mouse position.

Source:
mapspace-global/actions/viewerinfo.js
Returns:

The projection to report mouse position in.

Type
ol.proj.Projection | undefined

handleOutputProjectionChanged()

Set output projection system for viewer info (and another tools).

Source:
mapspace-global/actions/viewerinfo.js

is2DViewer()

Return true if current viewer of the action is a 2D viewer.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

is3DViewer()

Return true if current viewer of the action is a 3D viewer.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

isGlobalViewer()

Return true if current viewer of the action is a Mapspace.global.Viewer.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

isObliqueViewer()

Return true if current viewer of the action is a Mapspace.oblique.Viewer.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

isObliqueViewerVisible()

Return true if current viewer of the action is a Mapspace.oblique.Viewer or a Mapspace.global.Viewer in Oblique mode.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

isOrthoViewer()

Return true if current viewer of the action is a Mapspace.ortho.Viewer.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

isOrthoViewerVisible()

Return true if current viewer of the action is a Mapspace.ortho.Viewer or a Mapspace.global.Viewer in Ortho mode.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

isProfile3dViewer()

Return true if current viewer of the action is a Mapspace.profile3d.Viewer.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

isStreetViewer()

Return true if current viewer of the action is a Mapspace.street.Viewer.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

isTableViewer()

Return true if current viewer of the action is a Mapspace.table.Viewer.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

isThreedViewer()

Return true if current viewer of the action is a Mapspace.threed.Viewer.

Inherited From:
Source:
mapspace/actions/action.js
Returns:
Type
boolean

setProjection(projection)

Set the projection that is used to report the mouse position.

Parameters:
Name Type Description
projection ol.proj.Projection

The projection to report mouse position in.
Source:
mapspace-global/actions/viewerinfo.js

update()

Updates the initial infoValues.

Source:
mapspace-global/actions/viewerinfo.js