Namespace: ortho

bu. ortho

This is the main namespace of the Ortho module, that contains the bu.ortho.Viewer. This viewer shows orthographic imagery and vector data in 2D render.

Source:
bu-ortho/bu.ortho.jsdoc

Classes

BlomURBEXBaseLayerEvent
Viewer

Namespaces

action
controldef
source

Type Definitions


LayerFilterFunctionType

Type of functions to filter information in layers.

ALLLAYERS: 'alllayers' // The function will include all layers
ALLVECTOR: 'allvector' // The function will include all vector layers
ALLVECTOREXCEPTPANORAMAS: 'allvectorexceptpanoramas' // The function will include 
 // all vector layers except the Panoramas layer
ALLVECTOREXCEPTPANORAMASPOINTSLINES: 'allvectorexceptpanoramaspointslines' // The 
 // function will include all vector layers, but for a Panoramas layer
 // it will include only 
Type:
  • string
Source:
bu-ortho/enums.js

MeasurementType

Type of the ortho measurement (point, length, ground elevation, ground length, area, bearing) for ortho viewers.

POINT: 'point'
LENGTH: 'length'
GROUND_LENGTH: 'groundlength'
AREA: 'area'
BEARING: 'bearing'
ELEVATION: 'elevation'
Type:
  • string
Source:
bu-ortho/enums.js

ViewerEventType

Type of events for a bu.ortho.Viewer.

CENTERCHANGED: 'change:center'
CONSTRAINROTATIONCHANGED: 'change:constrainrotation'
ENABLEROTATIONCHANGED: 'change:enablerotation'
EXTENTCHANGED: 'change:extent'
MAXRESOLUTIONCHANGED: 'change:maxresolution'
MINRESOLUTIONCHANGED: 'change:minresolution'
MAXZOOMCHANGED: 'change:maxzoom'
MINZOOMCHANGED: 'change:minzoom'
PROJECTIONCHANGED: 'change:projection'
RESOLUTIONCHANGED: 'change:resolution'
RESOLUTIONSCHANGED: 'change:resolutions'
ROTATIONCHANGED: 'change:rotation'
ZOOMCHANGED: 'change:zoom'
ZOOMFACTORCHANGED: 'change:zoomfactor'
LAYERGROUPCHANGED: 'change:layergroup'
PANORAMACLICKED: 'panoramaclicked' // Triggered when a BlomURBEX panorama is 
 // clicked in a viewer containing a layer with BlomUBEX panoramas.
BASELAYERCHANGED: 'baselayerchanged' // Triggered when a BlomURBEX base layer 
 // changes its source.
Type:
  • string
Source:
bu-ortho/enums.js

ViewerOptions

Options for bu.ortho.Viewer.

Type:
  • Object
Properties:
Name Type Description
target Element | string | undefined

The DOM target element where this viewer will be appended.

center bu.Coordinate | undefined

The initial center for the view. The coordinate system for the center is always an EPSG:4326 LanLot.

constrainRotation boolean | number | undefined

Rotation constraint. false means no constraint. true means no constraint, but snap to zero near zero. A number constrains the rotation to that number of values. For example, 4 will constrain the rotation to 0, 90, 180, and 270 degrees. The default is true.

enableRotation boolean | undefined

Enable rotation. Default is true. If false a rotation constraint that always sets the rotation to zero is used. The constrainRotation option has no effect if enableRotation is false.

extent bu.Extent | undefined

The extent that constrains the center, in other words, center cannot be set outside this extent. Default is undefined.

maxResolution number | undefined

The maximum resolution used to determine the resolution constraint. It is used together with minResolution (or maxZoom) and zoomFactor. If unspecified it is calculated in such a way that the projection's validity extent fits in a 256x256 px tile. If the projection is Spherical Mercator (the default) then maxResolution defaults to 40075016.68557849 / 256 = 156543.03392804097.

minResolution number | undefined

The minimum resolution used to determine the resolution constraint. It is used together with maxResolution (or minZoom) and zoomFactor. If unspecified it is calculated assuming 29 zoom levels (with a factor of 2). If the projection is Spherical Mercator (the default) then minResolution defaults to 40075016.68557849 / 256 / Math.pow(2, 28) = 0.0005831682455839253.

maxZoom number | undefined

The maximum zoom level used to determine the resolution constraint. It is used together with minZoom (or maxResolution) and zoomFactor. Default is 28. Note that if minResolution is also provided, it is given precedence over maxZoom.

minZoom number | undefined

The minimum zoom level used to determine the resolution constraint. It is used together with maxZoom (or minResolution) and zoomFactor. Default is 0. Note that if maxResolution is also provided, it is given precedence over minZoom.

projection string | undefined

The projection. Default is EPSG:3857 (Spherical Mercator).

resolution number | undefined

The initial resolution for the view. The units are projection units per pixel (e.g. meters per pixel). An alternative to setting this is to set zoom. Default is undefined, and layer sources will not be fetched if neither this nor zoom are defined.

resolutions Array.<number> | undefined

Resolutions to determine the resolution constraint. If set the maxResolution, minResolution, minZoom, maxZoom, and zoomFactor options are ignored.

rotation number | undefined

The initial rotation for the view in radians (positive rotation clockwise). Default is 0.

zoom number | undefined

Only used if resolution is not defined. Zoom level used to calculate the initial resolution for the view. The initial resolution is determined using the ol.View#constrainResolution method.

zoomFactor number | undefined

The zoom factor used to determine the resolution constraint. Default is 2.

layers Array.<Object> | undefined

Layers. If this is not defined, a map with no layers will be rendered. Note that layers are rendered in the order supplied, so if you want, for example, a vector layer to appear on top of a tile layer, it must come after the tile layer.

Source:
bu-ortho/typedefs.js

ViewerProperty

Properties of a bu.ortho.Viewer.

CENTER: 'center'
CONSTRAINROTATION: 'constrainRotation'
ENABLEROTATION: 'enableRotation'
EXTENT: 'extent'
MAXRESOLUTION: 'maxResolution'
MINRESOLUTION: 'minResolution'
MAXZOOM: 'maxZoom'
MINZOOM: 'minZoom'
PROJECTION: 'projection'
RESOLUTION: 'resolution'
RESOLUTIONS: 'resolutions'
ROTATION: 'rotation'
ZOOM: 'zoom'
ZOOMFACTOR: 'zoomFactor'
LAYERGROUP: 'layergroup'
CONTROLS: 'controls'
Type:
  • string
Source:
bu-ortho/enums.js