M/impl/Map~Map


import Map from 'M/impl/Map';

Main constructor of the class. Creates a Map with the specified div

new Map(div, options)

impl/ol/Map.js, line 85
Name Type Description
div Object
options Mx.parameters.MapOptions

Extends

  • M.Object

Members

module:M/impl/Map~Map.Z_INDEX{Object}

Z-INDEX for the layers

Methods

module:M/impl/Map~Map.registerBaseLayerType()

impl/ol/Map.js, line 2287

This function register base layer type

module:M/impl/Map~Map.registerExternalFunction()

impl/ol/Map.js, line 2266

This function register external function

addControls(controls){Map}

impl/ol/Map.js, line 1438

This function adds controls specified by the user

Name Type Description
controls M.Control

addKML(layers){Map}

impl/ol/Map.js, line 608

This function adds the KML layers to the map

Name Type Description
layers Array.<M.layer.KML>

addLabel(popup){ol.Map}

impl/ol/Map.js, line 2056

This function adds a popup and removes the previous showed

Name Type Description
popup M.impl.Popup

to add

addMVT()

impl/ol/Map.js, line 1340

This function adds the vector tile layers

addWFS(layers){Map}

impl/ol/Map.js, line 953

This function adds the WFS layers to the map

Name Type Description
layers Array.<M.layer.WFS>

addWMC(layers){Map}

impl/ol/Map.js, line 491

This function adds the WMC layers to the map

Name Type Description
layers Array.<M.impl.layer.WMC>

addWMS(layers){Map}

impl/ol/Map.js, line 740

This function adds the WMS layers to the map

Name Type Description
layers Array.<FacadeWMS>

addWMTS(layers){Map}

impl/ol/Map.js, line 1072

This function adds the WMTS layers to the map

Name Type Description
layers Array.<M.layer.WMTS>

destroy()

impl/ol/Map.js, line 1957

This function destroys this map, cleaning the HTML and unregistering all events

enableDrag(active)

impl/ol/Map.js, line 2316

This function enables or disables the interaction DragPan

Name Type Default Description
active Boolean true

enableMouseWheel(active)

impl/ol/Map.js, line 2302

This function enables or disables the interaction MouseWheelZoom

Name Type Default Description
active Boolean true

getBaseLayers(filters){Array.<M.Layer>}

impl/ol/Map.js, line 258

This function gets the layers added to the map

Name Type Description
filters Array.<M.Layer>

to apply to the search

Returns:
layers from the map

getBbox(){Mx.Extent}

impl/ol/Map.js, line 1583

This function gets the current extent (bbox) of this map instance

getCenter(){Object}

impl/ol/Map.js, line 1692

This function gets the current center of this map instance

getContainer(){Object}

impl/ol/Map.js, line 2142

This function provides the core map used by the implementation

Returns:
core map used by the implementation

getControls(filters){Array.<M.Control>}

impl/ol/Map.js, line 1383

This function adds controls specified by the user

Name Type Description
filters string | Array.<String>

getExactScale(){number}

impl/ol/Map.js, line 1827

This function gets current scale for this map instance

getGeoJSON(filters){Array.<M.layer.WFS>}

impl/ol/Map.js, line 811

This function gets the GeoJSON layers added to the map

Name Type Description
filters Array.<M.Layer>

to apply to the search

Returns:
layers from the map

getGroupedLayers(){Array.<M.Layer>}

impl/ol/Map.js, line 368

Retrieves all layers which are in some LayerGroup

Returns:
grouped layers from the map

getImageMap()

impl/ol/Map.js, line 2329

This function generate image map

getKML(filters){Array.<M.layer.KML>}

impl/ol/Map.js, line 543

This function gets the KML layers added to the map

Name Type Description
filters Array.<M.Layer>

to apply to the search

Returns:
layers from the map

getLabel(popup){ol.Map}

impl/ol/Map.js, line 2072

This function adds a popup and removes the previous showed

Name Type Description
popup M.impl.Popup

to add

getLabels(popup){ol.Map}

impl/ol/Map.js, line 2086

This function adds a popup and removes the previous showed

Name Type Description
popup M.impl.Popup

to add

getLayerGroups(){Array.<M.layer.Group>}

impl/ol/Map.js, line 356

TODO

Returns:
layers from the map

getLayers(filters){Array.<M.Layer>}

impl/ol/Map.js, line 230

This function gets the layers added to the map

Name Type Description
filters Array.<M.Layer>

to apply to the search

Returns:
layers from the map

getMaxExtent(){Mx.Extent}

impl/ol/Map.js, line 1516

This function gets the maximum extent for this map instance

getMVT()

impl/ol/Map.js, line 1273

This function gets the vector tile layers

getProjection(){Mx.Projection}

impl/ol/Map.js, line 1908

This function gets the current projection of this map instance

getResolutions(){Array.<Number>}

impl/ol/Map.js, line 1713

This function gets the current resolutions of this map instance

getRotation(){number}

impl/ol/Map.js, line 2235

This function gets the rotation of the view map

getScale(){number}

impl/ol/Map.js, line 1797

This function gets current scale for this map instance

getWFS(filters){Array.<M.layer.WFS>}

impl/ol/Map.js, line 872

This function gets the WFS layers added to the map

Name Type Description
filters Array.<M.Layer>

to apply to the search

Returns:
layers from the map

getWMC(filters){Array.<M.layer.WMC>}

impl/ol/Map.js, line 436

This function gets the WMC layers added to the map

Name Type Description
filters Array.<M.Layer>

to apply to the search

Returns:
layers from the map

getWMS(filters){Array.<FacadeWMS>}

impl/ol/Map.js, line 658

This function gets the WMS layers added to the map

Name Type Description
filters Array.<M.Layer>

to apply to the search

Returns:
layers from the map

getWMTS(filters){Array.<M.layer.WMTS>}

impl/ol/Map.js, line 1006

This function gets the WMTS layers added to the map

Name Type Description
filters Array.<M.Layer>

to apply to the search

Returns:
layers from the map

getZoom(){Number}

impl/ol/Map.js, line 1638

This function gets the current zoom of this map instance

refresh(){Map}

impl/ol/Map.js, line 2129

This function refresh the state of this map instance, this is, all its layers.

Returns:
the instance

removeControls(layers){Map}

impl/ol/Map.js, line 1459

This function removes the controls from the map

Name Type Description
layers String | Array.<String>

removeKML(layers){Map}

impl/ol/Map.js, line 639

This function removes the KML layers to the map

Name Type Description
layers Array.<M.layer.KML>

removeLabel(){ol.Map}

impl/ol/Map.js, line 2098

This function provides ol3 map used by this instance

removeLayerGroups(layers){M.impl.Map}

impl/ol/Map.js, line 413

TODO

Name Type Description
layers Array.<M.layer.Group>

to remove

removeLayers(layers){Map}

impl/ol/Map.js, line 308

This function removes the layers from the map

Name Type Description
layers Array.<Object>

to remove

removeMVT()

impl/ol/Map.js, line 1322

This function removes the vector tile layers from map.

removePopup(popup){ol.Map}

impl/ol/Map.js, line 1938

This function adds a popup and removes the previous showed

Name Type Description
popup M.impl.Popup

to add

removeWFS(layers){Map}

impl/ol/Map.js, line 987

This function removes the WFS layers to the map

Name Type Description
layers Array.<M.layer.WFS>

removeWMC(layers){Map}

impl/ol/Map.js, line 514

This function removes the WMC layers to the map

Name Type Description
layers Array.<M.layer.WMC>

removeWMS(layers){Map}

impl/ol/Map.js, line 785

This function removes the WMS layers to the map

Name Type Description
layers Array.<FacadeWMS>

removeWMTS(layers){Map}

impl/ol/Map.js, line 1119

This function removes the WMTS layers to the map

Name Type Description
layers Array.<M.layer.WMTS>

setBbox(bbox, vendorOpts){Map}

impl/ol/Map.js, line 1550

This function sets current extent (bbox) for this map instance

Name Type Description
bbox Mx.Extent

the bbox

vendorOpts Object

vendor options

setCalculatedResolutions(_calculatedResolutions)

impl/ol/Map.js, line 2363

This function set _calculatedResolutions

Name Type Description
_calculatedResolutions Number

setCenter(center){Map}

impl/ol/Map.js, line 1666

This function sets current center for this map instance

Name Type Description
center Object

the new center

setFacadeMap()

impl/ol/Map.js, line 2153

This function sets the facade map to implement

setMaxExtent(maxExtent, zoomToExtent){Map}

impl/ol/Map.js, line 1488

This function sets the maximum extent for this map instance

Name Type Description
maxExtent Mx.Extent

the extent max

zoomToExtent Boolean

Set bbox

setProjection(bbox){Map}

impl/ol/Map.js, line 1848

This function sets current projection for this map instance

Name Type Description
bbox Mx.Projection

the bbox

setResolutions(resolutions){Map}

impl/ol/Map.js, line 1730

This function sets current resolutions for this map instance

Name Type Description
resolutions Array.<Number>

the resolutions

setRotation(rotation)

impl/ol/Map.js, line 2252

This function sets the rotation of the view map

Name Type Description
rotation number

setToClosestScale(resolution)

impl/ol/Map.js, line 2351

This function set scale to map

Name Type Description
resolution Number

setZoom(zoom){Map}

impl/ol/Map.js, line 1617

This function sets current zoom for this map instance

Name Type Description
zoom Number

the new zoom

updateResolutionsFromBaseLayer(){M.Map}

impl/ol/Map.js, line 1977

Updates the resolutions for this map calculated from base layers