Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 ActivateLayers
 AddDisplayMenuPanel
 AddInitExtensionControl
 AddNewComponent
 AddNewVector
 AddSearchControl
 AddWMSLayers
 AddWMTSLayers
 AddZoomBoxControl
 AddZoomControl
C
 ComprobarAtribuciones
 ComprobarCondicionesAtribuciones
D
 DeactivateInfoControl
 DeactivateZoomBoxControl
 DeleteSelection
 DesactivateLayers
 DisableMeasures
 DisableSetCenter
 docAddVector
 docAddVectorCluster
F
 Features
 Functions
G
 GetDisplayMenuPanel
 GetInitExtensionControl
 GetMap
 GetSearchControl
 GetSearchWidget
 GetZoomBoxControl
 GetZoomControl
I
 IGN API
 IGN API_Plugin
 InitApiCore
 InitControlPanel
 InitMapLayers
 InitSearch
 InitServiceLayers
 InitVectorLayer
 isMobile
M
 MeasureArea
 MeasureLinearDistance
R
 RemoveAllOverlays
 RemoveAllPopups
 RemoveInfoPopups
 RemoveInitExtensionControl
 RemoveMeasurePopups
 RemovePopup
 RemoverDisplayMenuPanel
 RemoveSearchControl
 RemoveZoomBoxControl
 RemoveZoomControl
S
 SearchFeatures
 SetCenter
 SetExtent
 SetStyleFeaturePopup
 SetStyleMeasure
 SetZoom
 ShowPopup
U
 Usage
ActivateLayers: function(layers)
Activate Service Layers.
AddDisplayMenuPanel: function()
Add control to display tool box components
AddInitExtensionControl: function()
Add initial zoom extension control to the map, based on OpenLayers 3 ol.control.ZoomToExtent.
AddNewComponent: function(newCompDiv,
title,
id)
Create a new component in the Tool Box (Menu Control Panel).
AddNewVector: function(projType,
vectorIGN,
vectorType,
zoomLevel)
Add new vectorial layers.
AddSearchControl: function()
Add control to include the search place names or address candidates from IDEE and CartoCiudad services using autocomplete functionality, and select one of them from the list of candidates.
AddWMSLayers: function(wmsLayer)
Show WMS layers
AddWMTSLayers: function(wmtsLayer)
Show WMTS layers
AddZoomBoxControl: function()
Add control to zoom rectangular box in teh map.
AddZoomControl: function()
Add zoom control to the map, based on OpenLayers 3 ol.control.Zoom.
ComprobarAtribuciones: function(extensionMapa,
fileKML)
Function called to replace the attribution name depending on the area where the center of the image is.
ComprobarCondicionesAtribuciones: function()
Function that verify 2 conditions, zoom level and visible layer.
DeactivateInfoControl: function()
Deactivate information control.
DeactivateZoomBoxControl: function()
Deactivate zoom box control.
DeleteSelection: function()
Delete all measures and vectorial layers displayed over the map.
DesactivateLayers: function(layers)
Desactivate Service Layers
DisableMeasures: function()
Disable the measure functionality over the map.
DisableSetCenter: function()
Disable the Set center functionality.
docAddVector : function(projType,
vectorIGN,
vectorType,
this_API_CORE,
zoomLevel)
Add new vectorial layers.
docAddVectorCluster : function(projType,
vectorIGN,
vectorType,
this_API_CORE,
distance,
showFeatures,
zoomLevel)
Add the input vector layer to the map, draw its features and add the layer into the TOC.
The API component may be programmatically invoked with a simple JavaScript call involving only two code lines to get a preconfigured viewer with default options.
GetDisplayMenuPanel: function()
Reference to the display menu panel control (Tool box).
GetInitExtensionControl: function()
Reference to initial extension control instance based on OpenLayers 3.
GetMap: function()
Reference to created instance of map based on OpenLayers 3.
GetSearchControl: function()
Reference to the control for searching place names or address candidates from IDEE and CartoCiudad services using autocomplete functionality, and select one of them from the list of candidates.
GetSearchWidget: function()
Reference to the selector IGN_search for searching place names or address candidates from IDEE and CartoCiudad services using autocomplete functionality, and select one of them from the list of candidates.
GetZoomBoxControl: function()
Reference to zoom rectangular box control instance based on OpenLayers 3.
GetZoomControl: function()
Reference to zoom control instance based on OpenLayers 3.
The Viewer API aims to be a component which allows to programmatically create Viewers on a simple and customizable manner, so that it is reusable not only for new Viewers but also to update existing ones, providing technological standardization and significantly reducing redundant efforts.
The API_Plugin groups all the functions to initialize the different components of the map.
InitApiCore : function()
Function called after creating the Map to initialize its components
InitControlPanel : function(elementSetVector)
Function initializing the control panel, preparing the tool box and the listeners for the different functionalities such as measuring, cleaning or centering the map.
InitMapLayers : function(elementSetVector)
Function initializing the map layer, preparing the layer tree, which is exactly the same as the openlayer layer array Listeners have to be defined to apply the changes that can be done on the openlayer array at the layer tree, so as to keep the structure
InitSearch : function(objMap)
Function initializing the search module
InitServiceLayers: function(elementSetVector)
Function initializing the service layer, preparing the map for the loading of WMS or wMTS layer.
InitVectorLayer: function(elementSetVector)
Function initializing the vector layer, preparing the loading of vector layers.
isMobile:function()
Specifies if the API is displayed in a mobile device
MeasureArea: function()
Draw and calculate the area in the map.
MeasureLinearDistance: function()
Draw and calculate the lineal distance between two points in the map.
RemoveAllOverlays:function()
Remove all overlays.
RemoveAllPopups:function()
Remove all popups.
RemoveInfoPopups:function()
Remove information of the popup.
RemoveInitExtensionControl: function()
Remove initial zoom extension control from the map.
RemoveMeasurePopups:function()
Remove measure of the popup.
RemovePopup:function(popupToRemove)
Remove popup.
RemoverDisplayMenuPanel: function()
Remove display menu panel control from the map.
RemoveSearchControl: function()
Remove control to include the search place names or address candidates from IDEE and CartoCiudad services using autocomplete functionality, and select one of them from the list of candidates.
RemoveZoomBoxControl: function()
Remove control to zoom rectangular box in the map.
RemoveZoomControl: function()
Remove zoom control from the map.
SearchFeatures: function()
Add control to get geojson feature collection related to the search place names or address candidates from IDEE and CartoCiudad services using autocomplete functionality, and select one of them from the list of candidates.
SetCenter: function()
Set center in the coordinate pointed by the mouse click event.
SetExtent: function(xmin,
ymin,
xmax,
ymax)
Set initial zoom extension.
SetStyleFeaturePopup: function(popupBorderColor,
popupFontColor,
popupFontSize,
popupfontFamily,
popupWidth)
Set new values (see input parameters) to perform a new style for vectorial features popups.
SetStyleMeasure: function(geomBorderColor,
geomFillColor,
geomLineDash,
geomBorderWidth,
pointerRadius,
pointerBorderColor,
pointerFillColor,
geomEndBorderColor,
geomEndFillColor,
geomEndBorderWidth,
popupBorderColor,
popupFontColor,
popupFontSize,
popupfontFamily,
popupWidth)
Set new values (see input parameters) to perform a new style for measure geometries (line and area) and associated popups.
SetZoom: function(zoom)
Add initial zoom.
ShowPopup:function (popupType,
popupPosition,
popupInfo)
Show popup with the information.
The IGN_API_CORE widget is used to load a map based on OpenLayers 3.
Close