v5 v4

Class: Map

cercalia.Map

The map is the main API component. You can use it for painting markers, features, etc...
Uses ol.Map 'core' OpenLayers3 .
For access to OpenLayers object, use the getMap() function

Example for creating the map:

    var map = new cercalia.Map({
        target:'divMap',
        controls: []
    });

We offer several basemaps: cercalia.MapTypes.CERCALIA, cercalia.MapTypes.OSM, cercalia.MapTypes.SATELLITE or cercalia.MapTypes.HYBRID. It's also possible to add or change a base map using WMS requests.

new cercalia.Map(options)

cercalia.map.js, line 101
Name Type Description
options cercaliax.MapOptions

Map options

Members

overlayLoading{cercalia.widget.LoadingOverlay}

"Loading" overlay, blocks the map use

Methods

addControl(control)

cercalia.map.js, line 3171

Add a control in the map, by parameter

Name Type Description
control cercalia.Control

addFeature(feature, layer)

cercalia.map.js, line 2574

Paint cercalia.Feature on the map.

Name Type Description
feature cercalia.Feature
layer ol.Layer | undefined optional

addFeatures(features, layer)

cercalia.map.js, line 2648

Paint several cercalia.Feature on the map. Must send an Array.

Name Type Description
features Array.<cercalia.Feature>

Array de cercalia.Feature
layer ol.layer

addLayer(layer, position)

cercalia.map.js, line 670

Adds a layer ol.layer.Layer specifying the position (optional). The layers are declarated in an array and the Z value works from less to more. The Layer basemap (map), is fixed in the first position 0.
If you need to change the baseLayer, change it to position 1 or remove the baseLayer.

Name Type Description
layer ol.layer
position number

addLinestring(linestring)

cercalia.map.js, line 2553

Paint cercalia.Linestring on the map

Name Type Description
linestring cercalia.Linestring

addLinestrings(linestrings)

cercalia.map.js, line 2565

Paint on the map the cercalia.Linestring list. In this function must send an Array.

Name Type Description
linestrings Array.<cercalia.Linestring>

addMarker(marker)

cercalia.map.js, line 2520

Paint cercalia.Marker list on the map.

Name Type Description
marker cercalia.Marker

addMarkers(markers)

cercalia.map.js, line 2536

Paint on the map the cercalia.Marker list. In this function must send an Array.

Name Type Description
markers Array.<cercalia.Marker>

addWMSLayer(wmsLayer, position)

cercalia.map.js, line 2443

Adds a WMS layer cercalia.WMS to the map

Name Type Description
wmsLayer cercalia.WMS
position number

WMSLayer position. If not declared, it's included just one level over the basemap.

boundsInsidePolygon_(bounds, polygon){boolean}

cercalia.map.js, line 3909

Check if bounds are inside a WKT polygon

Name Type Description
bounds cercalia.Bounds

Map bounds
polygon string

WKT Polygon
Returns:
True if inside

centerToFeatures(features, changeZoom, animation)

cercalia.map.js, line 2097

Center the map

Name Type Description
features Array.<cercalia.Feature> | cercalia.Feature

Features list or object.
changeZoom number

Change zoom on features center. Default: true
animation boolean

Animation. Default: true

centerToMarkers(markers, changeZoom, animation)

cercalia.map.js, line 2047

Centers the map with animation (or not) to the markers list. Optionally it's possible to change the zoom for including all the markers. If markers array is not specified, by default centers to all markers

Name Type Description
markers Array.<cercalia.Marker> | undefined optional
changeZoom boolean

Default: true
animation boolean

Default: true

clearCercaliaServices()

cercalia.map.js, line 3299

Resets services

closePopups()

cercalia.map.js, line 2923

Close all popups opened

coordToPixel(lonLat){ol.Pixel}

cercalia.map.js, line 1933

Returns the pixel value from a coordinate

Name Type Description
lonLat cercalia.LonLat

createContextMenuOption(buttonName, clickFunction, id)

cercalia.map.js, line 739

Add a new option in context menu, adding a function on click to this option.

Name Type Description
buttonName string

Text to show in the neu context menu option
clickFunction function

Function to call linked to new button
id string

Option's identifier.

createTopBar(){Element}

cercalia.map.js, line 3080

Create topbar

createWMSPOIs(categories)

cercalia.map.js, line 3238

Create a WMS POIs layer, specifying the categories to be painted.
Contact with Nexus Geografics for additional information and use.

Name Type Description
categories Array.<string> | string

deactivateControls()

cercalia.map.js, line 3197

Disable the active controls

destroy()

cercalia.map.js, line 3799

Destroy function

disableClustering()

cercalia.map.js, line 3549

Disable markers clustering. Every marker will be painted singly, with its icon.

disableDrawInteraction()

cercalia.map.js, line 3403

Disable the painting status

enableClustering(distance, clickFunction, mouseOverFunction, doubleClickFunction, mouseOutFunction)

cercalia.map.js, line 3423

Enable markers clustering. Note: When clustering is enabled drag markers won't work.

Name Type Default Description
distance number | undefined 40 optional

Distance, in pixels, to group markers with clusters. Default value: 40.
clickFunction function | undefined optional

Call function on cluster click.
Parameters avaliable (clusterFeature, features).
First parameter it's an object ol.Feature visible on map as a cluster,
Second parameter it's a cercalia.Marker array objects with the features contained in a cluster.
mouseOverFunction function | undefined optional

Call function on cluster mouseover. Same parameters used in 'clickFunction' event
doubleClickFunction function | undefined optional

Call function on double click on cluster.
Parameters avaliable (clusterFeature, features).

mouseOutFunction function | undefined optional

Call function on cluster mouseout. Same parameters used in 'clickFunction' event

enableDrawInteraction(type, dragFeatures, styles, drawEndFunction)

cercalia.map.js, line 3358

Enable the painting status. The features can be draggables, changing the features styles.

Name Type Description
type string

Type [Point|LineString|Polygon|Circle]
dragFeatures boolean | undefined optional

Boolean. true or false.
styles Object | undefined optional

JS object with the style values: [strokeColor, strokeWidth, strokeOpacity, fillColor, fillOpacity, radius]. For example: {strokeColor:'#ff0000',fillColor:'#00ff00',radius:5,fillOpacity:0.5}
drawEndFunction function | undefined optional

Call function when user finish drawing the feature. Send the same feature painted

enableFeatureEditable(enable)

cercalia.map.js, line 2626

Set the features as editables if it isn't, or change to not editable if it's editable.

Name Type Description
enable boolean

Set on/off the editable mode.

exportPNG(filename)

cercalia.map.js, line 3930

Export PNG image

Name Type Description
filename string | undefined optional

fitBounds(bounds, animation)

cercalia.map.js, line 2148

Fit the bounds: change the current map bounds to new bounds. By default applies animation effect

Name Type Description
bounds cercalia.Bounds

New bounds
animation boolean

True/False, if want to apply animation or not. Default: true

geolocation(callbackFn)

cercalia.map.js, line 931

Obtains the geocode at the API access point It is possible to declare a callback function, to be executed when obtains the geocode. When callback function is not avaliable, the map is centered to API access point.

Name Type Description
callbackFn function

getBaseLayer(){ol.layer.Tile}

cercalia.map.js, line 1842

Returns the layer (ol.layer.Tile) used as basemap

getBounds(){cercalia.Bounds}

cercalia.map.js, line 2134

Returns the current bounds

Returns:
Current bounds, according to the zoom level, position and widht-height

getCenter(){cercalia.LonLat}

cercalia.map.js, line 1867

Returns the map center.

Returns:
Coordinates.

getClass(){string}

cercalia.map.js, line 3593
Returns:
Object ClassName. Value: cercaila.Map.

getClosestFeature(position){cercalia.Feature}

cercalia.map.js, line 3609
Name Type Description
position cercalia.LonLat
Returns:
Nearest feature to coordinate

getClosestMarker(position){cercalia.Marker}

cercalia.map.js, line 3618
Name Type Description
position cercalia.LonLat
Returns:
Nearest marker to coordinate

getContextMenuOverlay(){ol.Overlay}

cercalia.map.js, line 3811

getControlsByName(controlName){ol.Control}

cercalia.map.js, line 2028

Obtains the map control from its name. Complete controls list (if are created):

  • cercalia.MapControls.CleanControl
  • cercalia.MapControls.DragControl
  • cercalia.MapControls.DrawControl
  • cercalia.MapControls.FullScreen
  • cercalia.MapControls.LayerSwitcher
  • cercalia.MapControls.Logistics
  • cercalia.MapControls.MeasureControl
  • cercalia.MapControls.MeteoControl
  • cercalia.MapControls.RotateNorth
  • cercalia.MapControls.ScaleLine
  • cercalia.MapControls.StreetView
  • cercalia.MapControls.Traffic
  • cercalia.MapControls.Zoom
  • cercalia.MapControls.ZoomSlider
Name Type Description
controlName string

getDragInteraction(){ol.interaction.DragInteraction}

cercalia.map.js, line 1851

Returns the drag interaction.

getDrawInteraction(){ol.interaction.DrawInteraction}

cercalia.map.js, line 1859

Returns the draw interaction.

getDrawLayer(){ol.layer.Vector}

cercalia.map.js, line 2462

Returns the layer (ol.layer.Vector) used for painting on the map.

Returns:
layer

getEventCoordinate(evt){cercalia.LonLat}

cercalia.map.js, line 1964
Name Type Description
evt event

getEventPixel(evt){Pixel}

cercalia.map.js, line 1956

Obtains pixel

Name Type Description
evt event

getFeatures(){Array.<cercalia.Linestring>|null}

cercalia.map.js, line 2695

Obtain all the cercalia.Feature painted on the map

Returns:
Linestring list painted on the map

getId(){string}

cercalia.map.js, line 1815

Returns the map internal ID.

Returns:
map internal ID.

getInteractionDrag(){cercalia.Interaction.DragFeatures}

cercalia.map.js, line 3793
Returns:
dragInteraction

getLayerByName(layerName){ol.layer}

cercalia.map.js, line 1995
Name Type Description
layerName string
Returns:
Layer objeto ol3

getLayerIndexByName(layerName){number}

cercalia.map.js, line 2472

Obtains the layer position (Z value). The layers are painted respecting Z position: 0 is the base map.

Name Type Description
layerName string
Returns:
Layer position

getLinestrings(){Array.<cercalia.Linestring>|null}

cercalia.map.js, line 2687

Obtain all the cercalia.Linestring painted on the map

Returns:
Linestrings list painted on the map

getMainMenu(){cercalia.widget.MainMenu}

cercalia.map.js, line 3586
Returns:
Returns the reference to cercalia.widget.MainMenu

getMap(){ol.Map}

cercalia.map.js, line 1833

Returns the OpenLayers3 object ol.Map

Returns:
Map

getMarkerById(){cercalia.Marker}

cercalia.map.js, line 2673
Returns:
marker

getMarkers(){Array.<cercalia.Marker>|null}

cercalia.map.js, line 2656

Obtain all the cercalia.Marker painted on the map

Returns:
Marker list painted on the map

getOverlappedMarkers(currentExtentView, tolerance){Array.<Array.<cercalia.Marker>>}

cercalia.map.js, line 1501

Get Overlapped markers

Name Type Description
currentExtentView boolean | undefined optional

If true returns only visible markers at the moment, if not null or false it returns all markers
tolerance boolean | undefined optional

Tolerance in meters.

getProjectionCode(){string}

cercalia.map.js, line 2333

Obtains the map projection code

Returns:
EPSG code. For example: EPSG:3857.

getRightClickMenuOptions(){array.<string>}

cercalia.map.js, line 3641
Returns:
return rightClick menu options.

getRouteMap(){cercalia.RouteMap}

cercalia.map.js, line 3346
Returns:
routeMap

getScaleUnits()

cercalia.map.js, line 3952
Returns:
scale units. Values metric or imperial

getViewOptions(){Object}

cercalia.map.js, line 3600
Returns:
View options from cercalia map.

getZoom(){number}

cercalia.map.js, line 1906
Returns:
Current zoom level of map.

hideAllControls()

cercalia.map.js, line 3159

Hide all controls

hideLabels()

cercalia.map.js, line 2885

Hide all labels cercalia.Label from markers painted on the map

hideLoading()

cercalia.map.js, line 3825

Hide "Loading..."

openContextMenu(lonLat)

cercalia.map.js, line 752

Open the context menu at the coordinates specified by parameters. If not specified, opens the context menu in the map center according to the current position.

Name Type Description
lonLat cercalia.LonLat | undefined optional

Coordinate

openPopups()

cercalia.map.js, line 2936

Show all markers popups. Only for markers with popup created

overlapMarkers()

cercalia.map.js, line 1605

Separate overlapped markers when its have same position.

panTo(lonLat, animation, duration)

cercalia.map.js, line 2198

Moves the map to the new center. Optional: animation effect-

Name Type Description
lonLat cercalia.LonLat

Coordinate
animation string

Boolean animation effect. Values true or false, specifying the type of animation: cercalia.MapAnimation.ROTATE_LEFT, cercalia.MapAnimation.ROTATE_RIGHT, cercalia.MapAnimation.PAN, cercalia.MapAnimation.ELASTIC, cercalia.MapAnimation.BOUNCE, cercalia.MapAnimation.FLY, cercalia.MapAnimation.SPIRAL
duration number

Animation duration (in miliseconds). Defaulf 2000.

panToBounds(bounds, animation, duration)

cercalia.map.js, line 2181

Map center maintaining the zoom level

Name Type Description
bounds cercalia.Bounds

Mapbounds.
animation boolean

Boolean for apply or not animation effect. Values: true or false.
duration number

Animation duration (in miliseconds). Default 2000.

pixelsToMeters(pixels){number}

cercalia.map.js, line 1976

Calculate the real distance in meters, from pixels values.

Name Type Description
pixels number
Returns:
meters

pixelToCoord(pixel){cercalia.LonLat}

cercalia.map.js, line 1944

Returns the coordinate from a pixel value

Name Type Description
pixel ol.Pixel
Returns:
Coordinate

removeAllFeatures()

cercalia.map.js, line 2849

Clean all features

removeAllLinestrings()

cercalia.map.js, line 2841

Clean all linestrings

removeAllMarkers()

cercalia.map.js, line 2833

Clean all markers and popups

removeAllOverlays()

cercalia.map.js, line 2872

Clean all overlays painted on the map

removeApiMarkers(markers)

cercalia.map.js, line 2757

Remove API markers list from map

Name Type Description
markers cercalia.Marker | Array.<cercalia.Marker>

removeApiRoute()

cercalia.map.js, line 840
Deprecated
  • deprecated function, equivalent: map.getRouteMap().removeRoute();

    removeDrawFeatures()

    cercalia.map.js, line 2858

    Clean all the features painted on the map with draw tool. Layer 'DrawLayer'

    removeFeatures(features, layer)

    cercalia.map.js, line 2777

    Remove features list from map

    Name Type Description
    features cercalia.Feature | Array.<cercalia.Feature>
    layer ol.Layer | undefined optional

    If not defined it will remove features in internal Cercalia layer.

    removeLayer(layer)

    cercalia.map.js, line 692

    Clean the layer specified by parameter

    Name Type Description
    layer ol.layer

    removeLinestrings(linestrings)

    cercalia.map.js, line 2767

    Remove linestring list from map

    Name Type Description
    linestrings cercalia.Linestring | Array.<cercalia.Linestring>

    removeMarkers(markers)

    cercalia.map.js, line 2747

    Remove markers list from map

    Name Type Description
    markers cercalia.Marker | Array.cercalia.Marker

    removeWMSLayer(wmsLayer)

    cercalia.map.js, line 2452

    Remove a WMS layer cercalia.WMS from the map

    Name Type Description
    wmsLayer cercalia.WMS

    removeWMSPOIs()

    cercalia.map.js, line 3225

    Clean POIs layers, if painted

    rotate(angle)

    cercalia.map.js, line 2324

    Rotates the map degrees, by parameter

    Name Type Description
    angle number

    Angle (degrees).

    setBaseLayer(mapType)

    cercalia.map.js, line 2956
    Name Type Description
    mapType string | cercalia.WMS | ol.layer.Layer | ol.layer.Group

    Change base map.
    Maps avaliable by default. String:

    • cercalia.MapTypes.CERCALIA Cercalia
    • cercalia.MapTypes.OSM Cercalia
    • cercalia.MapTypes.SATELLITE
    • cercalia.MapTypes.HYBRID

      Also can use a WMS layer (object cercalia.WMS), that will be set as base Layer. Also can add layers using OpenLayers classes ol.layer.Layer y ol.layer.Group.

    setCenter(lonLat, zoom, animation)

    cercalia.map.js, line 1878

    Set the map center

    Name Type Description
    lonLat cercalia.LonLat

    Coordinates
    zoom number

    Zoom
    animation boolean | undefined optional

    Animation, activated by default

    setDefaultClick(func)

    cercalia.map.js, line 641
    Name Type Description
    func function | undefined optional

    Function

    setFeatureEditable(feature, edit)

    cercalia.map.js, line 2604

    Set feature editable.

    Name Type Description
    feature cercalia.Feature

    Feature to be edited.
    edit boolean

    Set the feature as editable or not.

    setProjection(projection)

    cercalia.map.js, line 2359

    Changes the projection to basemap and all the layers painted over it (markers, features, WMS, etc).

    Name Type Description
    projection ol.Projection

    Projection.

    setRestrictedView(minZoom, maxZoom, bounds)

    cercalia.map.js, line 2343

    Fixes the minimum and maximum zoom level

    Name Type Description
    minZoom number | boolean

    Min zoom, false if don't want this limit
    maxZoom number | boolean

    Max zoom, false if don't want this limit
    bounds cercalia.Bounds

    Map bounds limits

    setRightClickMenuOptions(Set)

    cercalia.map.js, line 3649
    Name Type Description
    Set array.<string>

    rightClick menu options.

    setRotation(angle)

    cercalia.map.js, line 2316

    Sets the map rotation

    Name Type Description
    angle number

    setRouteMap(routeMap)

    cercalia.map.js, line 3338
    Name Type Description
    routeMap cercalia.RouteMap

    setZoom(zoom, animation)

    cercalia.map.js, line 1916

    Set the zoom level of map. If second parameter is specified (boolean, optional), can apply animation effect

    Name Type Description
    zoom number

    Zoom level to adjust
    animation boolean

    True/False if want to apply animation effect. Defaulf: true

    showAllControls()

    cercalia.map.js, line 3148

    Show all controls

    showingLabels(){Boolean}

    cercalia.map.js, line 2916

    Returns boolean showing if all labels are showing or hidden.

    showLabels()

    cercalia.map.js, line 2898

    Show all labels cercalia.Label from markers painted on the map

    showLoading()

    cercalia.map.js, line 3818

    Shows "Loading..."

    showMarkers(markers, show)

    cercalia.map.js, line 2731

    Show the markers painted on the map. This function is usefull when some or all markers are hidden.

    Name Type Description
    markers cercalia.Marker | Array.<cercalia.Marker>
    show boolean