Class: OlMap

bemap.OlMap(context, target)

Base class for OpenLayers.

Constructor

new OlMap(context, target)

Parameters:
Name Type Description
context bemap.Context BeMap-JS-API Context.
target string HTML element.
options.
Source:

Extends

Members

(protected) callback

Inherited From:
Source:

(protected) ctx

Inherited From:
Source:

(protected) events

Inherited From:
Source:

(protected) layers

Inherited From:
Source:

(protected) native

Overrides:
Source:

(protected) target

Source:

Methods

(protected) _addOwnToProperties(bemapObject)

Sotre the bemap object into the native OpenLayers properties.
Parameters:
Name Type Description
bemapObject Object a bemap object like bemap.marker, bemap.multimarker or bemap.polyline.
Source:

(protected) _checkModeOfEvent(mode, bemapObject, declaredObj) → {function}

Check the event mode.
Parameters:
Name Type Description
mode object enable modes.
bemapObject object bemap object like bemap.Marker, bemap.Polyline, etc.
declaredObj object bemap object like bemap.Marker, bemap.Polyline, etc.
Source:
Returns:
Type
function

(protected) _draggableFeature(declaredObj, callback, options, mode) → {bemap.Listener}

Define the draggable capability for bemap object (like bemap.Marker, bemap.MultiMarker, bemap.Polyline, etc.).
Parameters:
Name Type Description
declaredObj Object bemap object like bemap.Marker, bemap.MultiMarker, bemap.Polyline, etc.
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
mode object Mode of slection feature.
Source:
Returns:
Listener.
Type
bemap.Listener

(protected) _fromLonLat(lon, lat)

Parameters:
Name Type Description
lon double Longitude in degres decimal (WGS84).
lat double Latitude in degres decimal (WGS84).
Source:

(protected) _fromNativeToLonLat(coordinate) → {array}

Parameters:
Name Type Description
coordinate array Array contains the longitude and latitude in format of OpenLayers Map object.
Source:
Returns:
Array contains the longitude and latitude in degres decimal (WGS84).
Type
array

(protected) _getOwnFromProperties(olObject) → {Object}

Get the bemap object from the native OpenLayers properties.
Parameters:
Name Type Description
olObject Object native Openlayers object like ol.Feature.
Source:
Returns:
a bemap object like bemap.marker, bemap.multimarker or bemap.polyline.
Type
Object

(protected) _onFeature(marker, eventType, callback, options, mode) → {bemap.Listener}

Set the listner when a specified eventType occur on OpenLayers Feature object.
Parameters:
Name Type Description
marker bemap.Marker
eventType bemap.Map.EventType Event type.
callback function Function will be called when the specified eventType is occur.
options object options.
mode object Mode of slection feature.
Source:
Returns:
listener.
Type
bemap.Listener

addCircle(options) → {bemap.OlMap}

Add a bemap.Circle to the layer
Parameters:
Name Type Description
bemap.Circle. bemap.Circle
options object
Source:
Returns:
Type
bemap.OlMap

addLayer(layer, options) → {bemap.OlMap}

Add a layer to the OpenLayers map.
Parameters:
Name Type Description
layer bemap.Layer
options object
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

addMarker(marker, options) → {bemap.OlMap}

Add a marker to the layer
Parameters:
Name Type Description
marker bemap.Marker
options object
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

addMultiMarker(multimarker, options) → {bemap.OlMap}

Add a multimarker to the layer
Parameters:
Name Type Description
multimarker bemap.Marker
options object
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

addPolygon(options) → {bemap.OlMap}

Add a bemap.Polygon to the layer
Parameters:
Name Type Description
bemap.Polygon. bemap.Polygon
options object
Source:
Returns:
Type
bemap.OlMap

addPolyline(options) → {bemap.OlMap}

Add a bemap.Polyline to the layer
Parameters:
Name Type Description
bemap.Polyline. bemap.Polyline
options object
Overrides:
Source:
Returns:
Type
bemap.OlMap

addPopup(popup, options) → {bemap.OlMap}

Add a popup to the map
Parameters:
Name Type Description
popup bemap.Popup
options object
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

backgroundLayers(geoservers) → {bemap.Map}

Create a background layer for each geoserver name.
Parameters:
Name Type Description
geoservers array List of geoserver name.
Inherited From:
Source:
Returns:
this
Type
bemap.Map

buildCircleStyle(circleStyle, options) → {bemap.OlMap}

Build circleStyle resource.
Parameters:
Name Type Description
circleStyle bemap.CircleStyle
options object
Source:
Returns:
this
Type
bemap.OlMap

buildIcon(icon, options) → {bemap.OlMap}

Build icon resource.
Parameters:
Name Type Description
icon bemap.Icon
options object
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

buildLineStyle(lineStyle, options) → {bemap.OlMap}

Build lineStyle resource.
Parameters:
Name Type Description
lineStyle bemap.LineStyle
options object
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

buildPolygonStyle(polygonStyle, options) → {bemap.OlMap}

Build polygonStyle resource.
Parameters:
Name Type Description
polygonStyle bemap.PolygonStyle
options object
Source:
Returns:
this
Type
bemap.OlMap

buildTextStyle(text, name, options) → {bemap.OlMap}

Build text style resource.
Parameters:
Name Type Description
text bemap.TextStyle style object.
name String Name (label) of marker.
options object
Source:
Returns:
this
Type
bemap.OlMap

clearLayer(layer) → {bemap.OlMap}

Remove all objects from a layer.
Parameters:
Name Type Description
layer bemap.Layer the layer object to clear.
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

clearPopup() → {bemap.OlMap}

Remove all the popups from the map.
Overrides:
Source:
Returns:
this;
Type
bemap.OlMap

defaultLayers(options) → {bemap.Map}

Add default layers.
Parameters:
Name Type Description
options object
Properties
Name Type Description
markerAsCluster boolean
Inherited From:
Source:
Returns:
this
Type
bemap.Map

defaultOverlayLayers(options) → {bemap.Map}

Add default overlay layers, like dedicated for markers or polyline, etc.
Parameters:
Name Type Description
options object
Properties
Name Type Description
markerAsCluster boolean
Inherited From:
Source:
Returns:
this
Type
bemap.Map

(protected) draggableCircle(circle, callback, options) → {bemap.Listener}

Define the draggable capability for bemap.Circle.
Parameters:
Name Type Description
circle bemap.Circle bemap object.
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
Source:
Returns:
bemap.listener.
Type
bemap.Listener

(protected) draggableCircles(callback, options) → {bemap.Listener}

Define the draggable capability for all bemap.Circle.
Parameters:
Name Type Description
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
Source:
Returns:
bemap.listener.
Type
bemap.Listener

(protected) draggableMarker(marker, callback, options) → {bemap.Listener}

Define the draggable capability for bemap.Marker.
Parameters:
Name Type Description
marker bemap.Marker bemap object.
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
Overrides:
Source:
Returns:
bemap.listener.
Type
bemap.Listener

(protected) draggableMarkers(callback, options) → {bemap.Listener}

Define the draggable capability for all bemap.Marker.
Parameters:
Name Type Description
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
Overrides:
Source:
Returns:
bemap.listener.
Type
bemap.Listener

(protected) draggableMultiMarkers(callback, options) → {bemap.Listener}

Define the draggable capability for all bemap.MultiMarkers.
Parameters:
Name Type Description
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
Overrides:
Source:
Returns:
bemap.listener.
Type
bemap.Listener

(protected) draggablePolygon(polygon, callback, options) → {bemap.Listener}

Define the draggable capability for bemap.Polygon.
Parameters:
Name Type Description
polygon bemap.Polygon bemap object.
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
Source:
Returns:
bemap.listener.
Type
bemap.Listener

(protected) draggablePolygons(callback, options) → {bemap.Listener}

Define the draggable capability for all bemap.Polygon.
Parameters:
Name Type Description
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
Source:
Returns:
bemap.listener.
Type
bemap.Listener

(protected) draggablePolyline(polyline, callback, options) → {bemap.Listener}

Define the draggable capability for bemap.Polyline.
Parameters:
Name Type Description
polyline bemap.Polyline bemap object.
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
Overrides:
Source:
Returns:
bemap.listener.
Type
bemap.Listener

(protected) draggablePolylines(callback, options) → {bemap.Listener}

Define the draggable capability for all bemap.Polyline.
Parameters:
Name Type Description
callback function Function will be called when the specified eventType is occur.
options object Options.
Properties
Name Type Description
layerFilter bemap.Layer set the bemap layer used as filter.
Overrides:
Source:
Returns:
bemap.listener.
Type
bemap.Listener

getBoundingBox() → {bemap.BoundingBox}

Get the limits of the map on the current zoom.
Overrides:
Source:
Returns:
the bounding box containing the limits.
Type
bemap.BoundingBox

getCenter() → {bemap.Coordinate}

Get the center of the map in bemap.Coordinate.
Overrides:
Source:
Returns:
the center of the map.
Type
bemap.Coordinate

getLayerByName(name) → {bemap.Layer}

Search the layer by name.
Parameters:
Name Type Description
name String of layer.
Inherited From:
Source:
Returns:
Return the layer or null if not found.
Type
bemap.Layer

getRotation() → {int}

Get current rotation angle of map.
Overrides:
Source:
Returns:
current rotation angle of map in degrees.
Type
int

getXYFromCoordinate() → {Array}

Get the pixel coordinate from bemap coordinate.
Source:
Returns:
the corresponding XY coords.
Type
Array

getZoom() → {int}

Get current zoom level of map.
Overrides:
Source:
Returns:
current zoom level of map.
Type
int

(abstract) isDragPan() → {boolean}

Return the satus of drag pan of map.
Parameters:
Name Type Description
options.dragPan. Object
Overrides:
Source:
Returns:
true to enable the drag pan of map, otherwise false.
Type
boolean

move(lon, lat, zoom, options) → {bemap.OlMap}

Move map to new coordinate.
Parameters:
Name Type Description
lon double Longitude in degres decimal (WGS84).
lat double Latitude in degres decimal (WGS84).
zoom int Zoom level (optional).
options Object Options (optional).
Properties
Name Type Description
animate String Enable the animation.
fly String Enable the animation (same as animate).
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

moveToBoundingBox(boundingBox) → {bemap.OlMap}

Set the center and the zoom of the map to fit the bounding box.
Parameters:
Name Type Description
boundingBox bemap.BoundingBox the bounding box to fit.
Overrides:
Source:
Returns:
this.
Type
bemap.OlMap

(abstract) moveToLayerData(layer, options) → {bemap.Map}

Move map and zoom on data contains in layers.
Parameters:
Name Type Description
layer bemap.Layer Layer.
options Object Options (optional).
Overrides:
Source:
Returns:
this
Type
bemap.Map

on(eventType, callback, options) → {bemap.Listener}

Set the listner when an specified eventType occur on bemap.OlMap.
Parameters:
Name Type Description
eventType bemap.Map.EventType Event type.
callback function Function will be called when the specified eventType is occur.
options object options.
Overrides:
Source:
Returns:
listner.
Type
bemap.Listener

onCircle(circle, eventType, callback, options) → {bemap.Listener}

Set the listner when an specified eventType occur on bemap.Circle.
Parameters:
Name Type Description
circle bemap.Circle
eventType bemap.Map.EventType Event type.
callback function Function will be called when the specified eventType is occur.
options object options.
Source:
Returns:
this.
Type
bemap.Listener

onGetFeatureInfo(layer, options) → {bemap.Listener}

Set get feature info call back.
Parameters:
Name Type Description
layer bemap.Layer set the bemap layer.
options object options.
Properties
Name Type Description
beforeCallback function callback called at data reception and before display the popup.
afterCallback function callback called after display the popup.
panningMap function enable the map panning animation. move map from the current position to the popup anchor at the center of map.
Overrides:
Source:
Returns:
listner;
Type
bemap.Listener

onMarker(marker, eventType, callback, options) → {bemap.Listener}

Set the listner when an specified eventType occur on bemap.Marker.
Parameters:
Name Type Description
marker bemap.Marker
eventType bemap.Map.EventType Event type.
callback function Function will be called when the specified eventType is occur.
options object options.
Overrides:
Source:
Returns:
this.
Type
bemap.Listener

onMarkers(eventType, callback, options) → {bemap.Listener}

Set the listner when an specified eventType occur on all bemap.Marker.
Parameters:
Name Type Description
eventType bemap.Map.EventType Event type.
callback function Function will be called when the specified eventType is occur.
options object options.
Overrides:
Source:
Returns:
this.
Type
bemap.Listener

onMultiMarker(multimarker, eventType, listener, options) → {bemap.Listener}

Set the listner when an specified eventType occur on bemap.MultiMarker.
Parameters:
Name Type Description
multimarker bemap.MultiMarker
eventType bemap.Map.EventType Event type.
listener function Function will be called when the specified eventType is occur.
options object options.
Source:
Returns:
bemap.Listener.
Type
bemap.Listener

onMultiMarkers(eventType, listener, options) → {bemap.Listener}

Set the listner when an specified eventType occur on all bemap.MultiMarker.
Parameters:
Name Type Description
eventType bemap.Map.EventType Event type.
listener function Function will be called when the specified eventType is occur.
options object options.
Overrides:
Source:
Returns:
bemap.Listener.
Type
bemap.Listener

onPolygon(polygon, eventType, callback, options) → {bemap.Listener}

Set the listner when an specified eventType occur on bemap.Polygon.
Parameters:
Name Type Description
polygon bemap.Polygon
eventType bemap.Map.EventType Event type.
callback function Function will be called when the specified eventType is occur.
options object options.
Source:
Returns:
this.
Type
bemap.Listener

onPolygons(eventType, callback, options) → {bemap.Listener}

Set the listner when an specified eventType occur on all bemap.Polygon.
Parameters:
Name Type Description
eventType bemap.Map.EventType Event type.
callback function Function will be called when the specified eventType is occur.
options object options.
Source:
Returns:
this.
Type
bemap.Listener

onPolyline(polyline, eventType, callback, options) → {bemap.Listener}

Set the listner when an specified eventType occur on bemap.Polyline.
Parameters:
Name Type Description
polyline bemap.Polyline
eventType bemap.Map.EventType Event type.
callback function Function will be called when the specified eventType is occur.
options object options.
Overrides:
Source:
Returns:
this.
Type
bemap.Listener

onPolylines(eventType, callback, options) → {bemap.Listener}

Set the listner when an specified eventType occur on all bemap.Polyline.
Parameters:
Name Type Description
eventType bemap.Map.EventType Event type.
callback function Function will be called when the specified eventType is occur.
options object options.
Overrides:
Source:
Returns:
this.
Type
bemap.Listener

(abstract) refresh(options) → {bemap.OlMap}

Refresh map.
Parameters:
Name Type Description
options Object Options (optional).
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

refreshLayer(layer) → {bemap.OlMap}

Refresh all objects from a layer.
Parameters:
Name Type Description
layer bemap.Layer the layer object to refresh.
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

removeCircle(circle)

Remove a circle from his layer.
Parameters:
Name Type Description
circle bemap.Circle the circle object to remove.
Source:

removeLayer(layer) → {bemap.OlMap}

Remove a layer from the map.
Parameters:
Name Type Description
layer bemap.Layer layer to remove from the map.
Overrides:
Source:
Returns:
this.
Type
bemap.OlMap

(protected) removeListener(listener, options) → {bemap.OlMap}

Remove listener.
Parameters:
Name Type Description
listener bemap.Listener Function will be called when the specified eventType is occur.
options object Options.
Source:
Returns:
this.
Type
bemap.OlMap

removeMarker(marker) → {bemap.OlMap}

Remove a marker from his layer.
Parameters:
Name Type Description
marker bemap.Marker the marker object to remove.
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

removeMultimarker(multimarker) → {bemap.OlMap}

Remove a multimarker from his layer.
Parameters:
Name Type Description
multimarker bemap.MultiMarker the multimarker object to remove.
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

removePolygon(polygon)

Remove a polygon from his layer.
Parameters:
Name Type Description
polygon bemap.Polygon the polygon object to remove.
Source:

removePolyline(polyline)

Remove a polyline from his layer.
Parameters:
Name Type Description
polyline bemap.Polyline the polyline object to remove.
Overrides:
Source:

removePopup(popup) → {bemap.OlMap}

Remove a popup from the map.
Parameters:
Name Type Description
popup bemap.Popup the popup to remove from the map.
Overrides:
Source:
Returns:
this;
Type
bemap.OlMap

rotation(angle, options) → {bemap.OlMap}

Rotation of map, set new angle of map.
Parameters:
Name Type Description
angle int in degrees.
options Object Options (optional).
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

(protected) setCoordinateCircle(circle) → {bemap.OlMap}

Set the coordinates of the circle.
Parameters:
Name Type Description
circle bemap.Circle the circle object to remove.
Source:
Returns:
this
Type
bemap.OlMap

(protected) setCoordinateMarker(marker) → {bemap.OlMap}

Set the coordinates of the marker.
Parameters:
Name Type Description
marker bemap.Marker the marker object to remove.
Source:
Returns:
this
Type
bemap.OlMap

setCoordinatePopup(popup, coordinate, options) → {bemap.OlMap}

Set the coordinate of the popup.
Parameters:
Name Type Description
popup bemap.Popup the popup of wich to set the coordinate.
coordinate bemap.Coordinate the new coordinate.
options object Options.
Properties
Name Type Description
panningMap bemap.Layer enable the map panning animation. move map from the current position to the popup anchor at the center of map.
Overrides:
Source:
Returns:
this.
Type
bemap.OlMap

(abstract) setDragPan(active) → {bemap.OlMap}

Enable or diable the drag pan of map.
Parameters:
Name Type Description
active boolean true to enable the drag pan of map, otherwise false.
options.dragPan. Object
Overrides:
Source:
Returns:
this
Type
bemap.OlMap

(protected) setRadiusCircle(circle) → {bemap.OlMap}

Set the radius of the circle.
Parameters:
Name Type Description
circle bemap.Circle the circle object to remove.
Source:
Returns:
this
Type
bemap.OlMap

setVisiblePopup(popup, visible) → {bemap.Popup}

Set the visiblility of the popup.
Parameters:
Name Type Description
popup bemap.Popup the popup.
visible Boolean true for visible and false for hidden.
Overrides:
Source:
Returns:
this.
Type
bemap.Popup

switchBackgroundLayer(geoserver) → {bemap.Map}

Switch bytween several background layers.
Parameters:
Name Type Description
geoserver String Name of geoserver.
Inherited From:
Source:
Returns:
this
Type
bemap.Map

updateCircleCenter()

Update the coordinate from the native map browser.
Source:

updatePolygonCoordinates()

Update the coordinates from the native map browser.
Source:

visibleLayer(layer) → {bemap.OlMap}

Set the visibility of the layer.
Parameters:
Name Type Description
layer bemap.Layer the layer of wich to set the visibility.
visible. boolean
Overrides:
Source:
Returns:
return this.
Type
bemap.OlMap

zoom(zoom, options) → {bemap.OlMap}

Zoom on map, set new zoom level.
Parameters:
Name Type Description
zoom int Zoom level (optional).
options Object Options (optional).
Overrides:
Source:
Returns:
this
Type
bemap.OlMap