Namespace: action

bu.ortho. action

This is the namespace that contains bu.action.Action specific for the bu.ortho.Viewer.

Source:
bu-ortho/actions/bu.ortho.action.jsdoc

Classes

BaselayerTypeSwitcher
FeatureInfo
Goto
LayerSwitcher
Measurements
MeasurementsClear
MeasurementsLabels
North
OpenStreetImage
Orientation
ScaleLine
ScreenShot
Search
Spinner
UserPlace
ViewerInfo
Zoom
ZoomSlider

Type Definitions


FeatureInfoOptions

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.

viewer bu.Viewer | undefined

The viewer this action is tied to.

layerFilterFunction function | undefined

Any function receiving two params, a resolution number and a ol.Layer.Layer object, and returning true or false, and that will be used to filter if feature information must be shown for a given layer.

Source:
bu-ortho/typedefs.js

MapRotationProperty

Properties of a bu.ortho.action.MousePosition.

ROTATION: 'rotation'
Type:
  • string
Source:
bu-ortho/enums.js

MeasurementsOptions

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.

viewer bu.Viewer | undefined

The viewer this action is tied to.

style ol.style.Style | undefined

style for the measurements once they are drawn.

interactionStyle ol.style.Style | undefined

style for the measurements while interaction occurs.

formatFunctions Object.<string, function()> | undefined

an object with bu.ortho.MeasurementType as keys and functions as values. Functions receive a ol.geom.Geometry as param and return a formatted string with the measurement.

Source:
bu-ortho/typedefs.js

NorthOptions

Options for bu.ortho.action.North.

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.

viewer bu.Viewer | undefined

The viewer this action is tied to.

duration number | undefined

Duration of the rotation animation in milliseconds.

Source:
bu-ortho/typedefs.js

SearchOptions

Options for bu.ortho.action.Search.

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.

viewer bu.Viewer | undefined

The viewer this action is tied to.

duration number | undefined

Duration of the animation in milliseconds.

Source:
bu-ortho/typedefs.js

SpinnerOptions

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.

viewer bu.Viewer | undefined

The viewer this action is tied to.

duration number | undefined

Duration of the rotation animation in milliseconds.

Source:
bu-ortho/typedefs.js

UserPlaceOptions

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.

viewer bu.Viewer | undefined

The viewer this action is tied to.

baseResolution number | undefined

The base resolution at which the user place icon toggles visibility.

userLocation bu.Coordinate | undefined

The coordinate of the default user location, in current internal ol.Map projection, which usually is 'EPSG:3857'.

Source:
bu-ortho/typedefs.js

ViewerInfoOptions

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.

viewer bu.Viewer | undefined

The viewer this action is tied to.

infoSetup Array.<bu.ViewerInfoOption> | undefined

the definition of the different informations.

projection ol.proj.Projection | undefined

For coordinates, a projection object to which transform coordinates. If no projection is given then current map projection is used.

undefinedHTML string | undefined

For coordinates HTML to show when no data is available. Defaults to an empty string.

Source:
bu-ortho/typedefs.js

ViewerInfoProperty

Properties of a bu.ortho.action.ViewerInfo.

PROJECTION: 'projection'
Type:
  • string
Source:
bu-ortho/enums.js

ZoomOptions

Options for bu.ortho.action.Zoom

Type:
  • Object
Properties:
Name Type Description
control bu.control.Control | undefined

The control this action is attached to.

viewer bu.Viewer | undefined

The viewer this action is tied to.

duration number | undefined

Duration of the zoom animation in milliseconds.

Source:
bu-ortho/typedefs.js