Mapea 4

Class: Map

Map

Main constructor of the class. Creates a Map
with parameters specified by the user

new Map(userParameters, options)

Parameters:
Name Type Description
userParameters string | Mx.parameters.Map

parameters
options Mx.parameters.MapOptions

custom options
for the implementation
provided by the user
Source:

Extends

Members

<static, constant> DRAWLAYER_STYLE :object

Draw layer style options.

Type:
  • object
Source:

_defaultProj :Boolean

Flag that indicates if the used projection
is by default

Type:
  • Boolean
Source:

panel :object

Type:
  • object
Source:

Methods

<static> LAYER_SORT()

TODO

Source:

_checkCompleted()

TODO

Source:

addKML(layersParam)

This function adds the KML layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.KML>
Source:
Returns:
Type
M.Map

addLabel(layersParam)

This function removes the WMC layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:

addLayers(layersParam)

This function adds layers specified by the user

Parameters:
Name Type Description
layersParam string | Object | Array.<String> | Array.< Object>
Source:
Returns:
Type
M.Map

addMBtiles(layersParam)

This function adds the MBtiles layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.MBtiles>
Source:
Returns:
Type
M.Map

addPanels()

TODO

Source:
Returns:
Type
M.Map

addPlugin(plugin)

This function adds an instance of a specified
developed plugin

Parameters:
Name Type Description
plugin Mx.Plugin

the plugin to add to the map
Source:
Returns:
Type
M.Map

addPopup()

TODO

Source:
Returns:

core map used by the implementation

Type
M.Map

addWFS(layersParam)

This function adds the WFS layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.WFS>
Source:
Returns:
Type
M.Map

addWMC(layersParam)

This function adds the WMC layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:
Returns:
Type
M.Map

addWMS(layersParam)

This function adds the WMS layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.WMS>
Source:
Returns:
Type
M.Map

addWMTS(layersParam)

This function adds the WMTS layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.WMTS>
Source:
Returns:
Type
M.Map

destroy()

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

Source:
Returns:
Type
M.Map

drawFeatures(features)

TODO

Parameters:
Name Type Description
features Array.< M.Feature> | M.Feature
Source:

drawPoints(points)

This function removes the WMC layers to the map

Parameters:
Name Type Description
points Array.<Mx.Point> | Mx.Point
Source:

fire()

Sets the callback when the instace is loaded

Inherited From:
Source:

getBaseLayers()

This function gets the base layers added to the map

Source:
Returns:
Type
Array.< M.Layer>

getBbox()

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

Source:
Returns:
Type
Mx.Extent

getCenter()

This function provides the current center of this
map instance

Source:
Returns:
Type
Array.<Number>

getContainer()

This function provides the core map used by the
implementation

Source:
Returns:

core map used by the implementation

Type
Object

getControls(controlsParam)

This function gets controls specified by the user

Parameters:
Name Type Description
controlsParam string | Array.<String>
Source:
Returns:
Type
Array.< M.Control>

getEnvolvedExtent()

This function provides the promise of envolved extent of this
map instance

Source:
Returns:
Type
Promise

getFeatureHandler()

This function adds layers specified by the user

Source:
Returns:
Type
M.handler.Feature

getImpl()

This function provides the implementation
of the object

Inherited From:
Source:
Returns:
Type
Object

getKML(layersParam)

This function gets the KML layers added to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:
Returns:
Type
Array.< M.layer.KML>

getLabel(layersParam)

This function removes the WMC layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:
Returns:
Type
M.Map

getLayers(layersParam)

This function gets the layers added to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:
Returns:
Type
Array.< M.Layer>

getMapImpl()

This function provides the core map used by the
implementation

Source:
Returns:

core map used by the implementation

Type
Object

getMaxExtent()

This function provides the maximum extent for this
map instance

Source:
Returns:
Type
Mx.Extent

getMBtiles(layersParam)

This function gets the MBtiles layers added to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:
Returns:

layers from the map

Type
Array.<M.layer.MBtiles>

getPanels()

TODO

Source:
Returns:
Type
array.< M.ui.Panel>

getPlugins(plugin)

TODO

Parameters:
Name Type Description
plugin Mx.Plugin

the plugin to add to the map
Source:
Returns:
Type
M.Map

getPopup()

TODO

Source:
Returns:

core map used by the implementation

Type
M.Popup

getProjection()

This function provides the current projection of this
map instance

Source:
Returns:
Type
Mx.Projection

getResolutions()

This function provides the resolutions of this
map instance

Source:
Returns:
Type
Array.<Number>

getScale()

This function provides the current scale of this
map instance

Source:
Returns:
Type
Mx.Projection

getWFS(layersParam)

This function gets the WFS layers added to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:
Returns:

layers from the map

Type
Array.< M.layer.WFS>

getWMC(layersParam)

This function gets the WMC layers added to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:
Returns:
Type
Array.< M.layer.WMC>

getWMS(layersParam)

This function gets the WMS layers added to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.WMC>
Source:
Returns:

layers from the map

Type
Array.< M.layer.WMS>

getWMTS(layersParam)

This function gets the WMTS layers added to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.WMTS>
Source:
Returns:

layers from the map

Type
Array.< M.layer.WMTS>

getZoom()

This function provides the current zoom of this
map instance

Source:
Returns:
Type
Number

on()

Sets the callback when the instace is loaded

Overrides:
Source:

once()

Sets the callback when the instace is loaded

Inherited From:
Source:

refresh()

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

Source:
Returns:

the instance

Type
M.Map

removeCenter()

This function remove center for this
map instance

Source:

removeControls(controlsParam)

This function removes the specified controls from the map

Parameters:
Name Type Description
controlsParam string | Array.<string>

specified by the user
Source:
Returns:
Type
M.Map

removeFeatures(features)

TODO

Parameters:
Name Type Description
features Array.< M.Feature> | M.Feature
Source:

removeKML(layersParam)

This function removes the KML layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.KML>
Source:
Returns:
Type
M.Map

removeLabel(layersParam)

This function removes the WMC layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:
Returns:
Type
M.Map

removeLayers(layersParam)

This function removes the specified layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>

specified by the user
Source:
Returns:
Type
M.Map

removeMBtiles(layersParam)

This function removes the MBtiles layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.MBtiles>
Source:
Returns:
Type
M.Map

removePanel()

TODO

Source:

removePlugins(plugins)

This function removes the specified plugins from the map

Parameters:
Name Type Description
plugins Array.< M.Plugin>

specified by the user
Source:
Returns:
Type
M.Map

removePopup()

TODO

Source:
Returns:

core map used by the implementation

Type
M.Map

removeWFS(layersParam)

This function removes the WFS layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.WFS>
Source:
Returns:
Type
M.Map

removeWMC(layersParam)

This function removes the WMC layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.Layer>
Source:
Returns:
Type
M.Map

removeWMS(layersParam)

This function removes the WMS layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.WMS>
Source:
Returns:
Type
M.Map

removeWMTS(layersParam)

This function removes the WMTS layers to the map

Parameters:
Name Type Description
layersParam Array.<string> | Array.<Mx.parameters.WMTS>
Source:
Returns:
Type
M.Map

setBbox(bboxParam)

This function sets the bbox for this
map instance

Parameters:
Name Type Description
bboxParam String | Array.<String> | Array.<Number> | Mx.Extent

the bbox
Source:
Returns:
Type
M.Map

setCenter(centerParam)

This function sets the center for this
map instance

Parameters:
Name Type Description
centerParam String | Array.<String> | Array.<Number> | Mx.Center

the new center
Source:
Returns:
Type
M.Map

setImpl(impl)

This function set implementation of this control

Parameters:
Name Type Description
impl M.Map

to add the plugin
Inherited From:
Source:

setMaxExtent(maxExtentParam, zoomToExtent)

This function sets the maximum extent for this
map instance

Parameters:
Name Type Description
maxExtentParam String | Array.<String> | Array.<Number> | Mx.Extent

the extent max
zoomToExtent Boolean

Set bbox
Source:
Returns:
Type
M.Map

setProjection(projection)

This function sets the projection for this
map instance

Parameters:
Name Type Description
projection String | Mx.Projection

the bbox
Source:
Returns:
Type
M.Map

setResolutions(resolutionsParam)

This function sets the resolutions for this
map instance

Parameters:
Name Type Description
resolutionsParam String | Array.<String> | Array.<Number>

the resolutions
Source:
Returns:
Type
M.Map

setTicket(ticket)

This function adds a ticket to control secure layers

Parameters:
Name Type Description
ticket String

ticket user
Source:

setZoom(zoomParam)

This function sets the zoom for this
map instance

Parameters:
Name Type Description
zoomParam String | Number

the zoom
Source:
Returns:
Type
M.Map

un()

Sets the callback when the instace is loaded

Inherited From:
Source:

zoomToMaxExtent()

This function gets and zooms the map into the
calculated extent

Source:
Returns:
Type
M.Map