Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ign-argentina/argenmap/llms.txt

Use this file to discover all available pages before exploring further.

The preferences.json file controls everything that is not a layer or basemap source: where the map opens, which colors the interface uses, which plugins are active, how the geocoder behaves, and dozens of other startup and appearance options. The file lives at src/config/preferences.json. If that file does not exist, Argenmap falls back to the defaults in src/config/default/preferences.json.
Changes to preferences.json take effect only after a full page reload. There is no hot-reload; refresh the browser tab after saving the file.

Map viewport

These settings control the initial map position and the zoom range the viewer enforces. They are applied only when the page URL does not already carry lat, lng, or zoom parameters.
mapConfig.center.latitude
number
Latitude of the map center on first load. Default: -40 (central Argentina).
mapConfig.center.longitude
number
Longitude of the map center on first load. Default: -59.
mapConfig.zoom.initial
number
Zoom level on first load. Default: 4.
mapConfig.zoom.min
number
Global minimum zoom the user can reach regardless of basemap. Default: 3.
mapConfig.zoom.max
number
Global maximum zoom the user can reach regardless of basemap. Default: 21.
"mapConfig": {
  "center": {
    "latitude": -40,
    "longitude": -59
  },
  "zoom": {
    "initial": 4,
    "min": 3,
    "max": 21
  }
}

UI initialization

onInit.showToolbar
boolean
Whether the toolbar is visible when the app first loads. Set to false to start with a clean map view. Default: true.
onInit.showLayerMenu
boolean
Whether the layers panel is open when the app first loads. Default: true.
"onInit": {
  "showToolbar": true,
  "showLayerMenu": true
}

Theme colors

The theme object lets you override every major interface color without writing CSS. All values are CSS color strings (hex, rgb(), rgba(), or named colors).
theme.headerBackground
string
Background color of the top header bar. Default: "#157DB9".
theme.menuBackground
string
Background color of the layers panel / side menu. Default: "#157DB9".
theme.bodyBackground
string
Background color of the main map body area (visible before tiles load). Default: "#0094d4".
theme.activeLayer
string
Highlight color applied to a layer button when that layer is active on the map. Default: "#33b560".
theme.iconBar
string
Color of the icons in the toolbar. Default: "#4f4f4f".
theme.btnColor
string
Color of button text and icons. Default: "#FFFFFF".
theme.textLegendMenu
string
Color of text inside the legend menu. Default: "#FFFFFF".
theme.textLegendMenuStyle
string
Additional inline CSS applied to legend menu text elements. Leave as "" for no extra styling.
theme.textMenu
string
Color of general text inside the layers panel. Default: "#FFFFFF".
theme.textMenuStyle
string
Additional inline CSS applied to layers panel text elements. Leave as "" for no extra styling.
"theme": {
  "headerBackground": "#157DB9",
  "menuBackground": "#157DB9",
  "bodyBackground": "#0094d4",
  "activeLayer": "#33b560",
  "iconBar": "#4f4f4f",
  "btnColor": "#FFFFFF",
  "textLegendMenu": "#FFFFFF",
  "textLegendMenuStyle": "",
  "textMenu": "#FFFFFF",
  "textMenuStyle": ""
}

logo.src
string
Path to the main logo image. Example: "src/config/styles/images/logo.png". Default points to the Argenmap banner in src/styles/images/.
logo.srcLogoMini
string
Path to the logo shown on narrow (mobile) viewports. Example: "src/config/styles/images/logo_mini.png".
logo.height
string
CSS height of the logo element. Example: "47px". Leave "" to let CSS determine the height.
logo.width
string
CSS width of the logo element. Example: "365px".
logo.miniHeight
string
CSS height of the mobile logo. Leave "" to use the default.
logo.miniWidth
string
CSS width of the mobile logo. Leave "" to use the default.
logo.style
string
Additional inline CSS for the logo image. Example: "filter: drop-shadow(1px 1px 1px #103847)".
logo.ministyle
string
Additional inline CSS for the mobile logo image. Example: "filter: drop-shadow(1px 1px 1px #103847); width: 128px;".
logo.title
string
Tooltip text shown when the user hovers over the logo. Example: "Argenmap".
URL the logo links to when clicked. Example: "https://www.ign.gob.ar/".

Logo text

The logoText object configures a text link that appears alongside the logo in the header. This is useful for displaying an organization name as a clickable link when a text label is preferred over or in addition to an image logo.
logoText.content
string
Text content displayed as the logo text link. Example: "Instituto Geográfico Nacional".
logoText.title
string
Tooltip text shown when hovering over the logo text link. Example: "Ir al sitio del IGN".
URL the logo text links to when clicked. Example: "https://www.ign.gob.ar/". Use "#" to disable the link.
"logoText": {
  "content": "Mi Organización",
  "title": "Ir al sitio de Mi Organización",
  "link": "https://www.miorganizacion.gob.ar/"
}

References image

The referencias object shows or hides a clickable icon in the top-right corner of the map. When clicked, the icon opens a full-size reference/legend image. This is useful for displaying a static map reference sheet alongside the interactive viewer.
referencias.show
boolean
Whether to display the references icon. Default: false.
referencias.icon
string
Path to the small icon image shown in the top-right corner. Clicking this icon opens the full reference image. Example: "src/config/default/styles/images/referencias.png".
referencias.image
string
Path to the full-size reference/legend image that opens when the icon is clicked. Example: "src/config/styles/images/legends/referencias.png".
referencias.width
string
CSS width of the references icon. Example: "25px".
referencias.height
string
CSS height of the references icon. Example: "31px".
"referencias": {
  "show": false,
  "icon": "src/config/default/styles/images/referencias.png",
  "image": "src/config/styles/images/legends/referencias.png",
  "width": "25px",
  "height": "31px"
}

Metadata

title
string
Browser tab title and page title. Example: "Argenmap".
website
string
Canonical URL for the deployment. Example: "https://www.ign.gob.ar/".
favicon
string
Path to the browser tab favicon. Example: "src/styles/images/favicon.ico".
metaTags.title
string
Open Graph / <meta name="title"> value for social sharing previews.
metaTags.description
string
<meta name="description"> content. Example: "Visor de mapas desarrollado por el Instituto Geográfico Nacional".
metaTags.image
string
Absolute URL to the image shown when the page is shared on social networks. Example: "/src/styles/images/argenmap.png".

The search bar lets users search for place names using IGN’s geocoder API. It is displayed as a floating input overlay on the map canvas.
Show or hide the layer panel’s built-in search box (the one that filters layers by name within the panel). Default: true.
searchbar.isActive
boolean
Show or hide the floating place-name search bar on the map canvas. Default: true.
searchbar.top
string
CSS top offset of the search bar from the top of the map. Default: "5px".
searchbar.left
string
CSS left offset of the search bar. Default: "40%".
searchbar.color_focus
string
Text color when the input is focused. Default: "#008dc9".
searchbar.background_color
string
Background color of the search input. Default: "rgba(255, 255, 255, 0.7)".
searchbar.strings.placeholder
string
Placeholder text inside the search input. Default: "Buscar lugar...".

Geocoder

geocoder.url
string
Base URL of the geocoding API. Default: "https://api.ign.gob.ar/buscador/". Do not modify unless you are pointing to a custom geocoder.
API path segment used for text searches. Default: "search".
geocoder.url_by_id
string
API path segment used to look up a result by ID. Default: "places".
geocoder.query
string
Query parameter name for the search term. Default: "q".
geocoder.lang
string
Language code for search results. Default: "es".
geocoder.limit
number
Maximum number of autocomplete results returned. Default: 5.
geocoder.key
string
Access key for the geocoder service. Leave as "" for the public IGN endpoint.
"searchbar": {
  "isActive": true,
  "top": "5px",
  "left": "40%",
  "color_focus": "#008dc9",
  "background_color": "rgba(255, 255, 255, 0.7)",
  "strings": {
    "placeholder": "Buscar lugar..."
  }
},
"geocoder": {
  "url": "https://api.ign.gob.ar/buscador/",
  "search": "search",
  "url_by_id": "places",
  "query": "q",
  "lang": "es",
  "limit": 5,
  "key": ""
}

Plugins

The excluded_plugins array disables specific toolbar tools. Add a plugin’s name to the array to remove it from the UI entirely. The following plugin names are recognized:
Plugin nameDescription
minimapMini overview map in the corner
ZoomHomeZoom-to-home-extent button
locateGeolocate-me button
MeasureDistance and area measurement tool
graticulaGraticule (coordinate grid) overlay
FullScreenFull-screen toggle
DrawDrawing tools (points, lines, polygons)
ScreenShoterScreenshot export
PrintPrint layout
pdfPrinterPDF export
LoadLayerLoad layer from URL tool
geoprocessingGeoprocessing panel
ConsultDataFeature info / data query
HelpHelp dialog
ConfigConfiguration dialog
accessibilityAccessibility toolbar
"excluded_plugins": ["minimap", "graticula", "FullScreen"]

Table view

table.isActive
boolean
When true, WMS feature-info responses are shown in a table instead of the default popup. Default: false.
table.rowsLimit
number
Maximum number of rows displayed in the table view. Default: 5.

Charts

charts.isActive
boolean
Enables or disables chart rendering for query results that contain numeric data. Default: true.

Layer options

layer_options.isActive
boolean
When true, additional per-layer controls (opacity slider, etc.) are shown in the layers panel. Default: false.

Hillshade

The hillshade feature adds an Esri World Hillshade overlay that can be toggled on any basemap listed in addTo.
hillshade.addTo
string[]
Array of basemap nombre values (from data.json) for which the hillshade toggle button should appear. Example: ["argenmap", "argenmap_gris"].
hillshade.url
string
Tile URL template for the hillshade service. Default: "https://services.arcgisonline.com/arcgis/rest/services/Elevation/World_Hillshade/MapServer/tile/{z}/{y}/{x}.png". Do not modify.
hillshade.switchLabel
string
Label on the hillshade toggle button. Default: "Agregar sombra de montaña Esri".
hillshade.attribution
string
Attribution text shown on the map when hillshade is active.
hillshade.icon
string
Path to the icon displayed on the hillshade toggle button. Example: "src/styles/images/mountains.svg".
hillshade.name
string
Internal name for the hillshade layer. Default: "hillshade".

Geoprocessing

geoprocessing.isActive
boolean
Enables or disables the geoprocessing panel entirely. Default: true.
geoprocessing.availableProcesses
array
Array of geoprocess definitions. Each entry specifies a name, geoprocess type key, baseUrl (WPS endpoint), layer, namePrefix for output layer names, and optional styles. See the Geoprocessing feature documentation for the full field reference.
"geoprocessing": {
  "isActive": true,
  "buttonTitle": "Geoprocesos",
  "buttonIcon": "fa fa-cog",
  "dialogTitle": "Geoprocesos",
  "strings": {
    "bounds": "Areas a procesar"
  },
  "availableProcesses": [
    {
      "name": "Curvas de Nivel",
      "geoprocess": "contour",
      "baseUrl": "https://imagenes.ign.gob.ar/geoserver/geoprocesos/ows?service=WPS&version=1.0.0",
      "layer": "alos_unificado",
      "namePrefix": "curvas_de_nivel_",
      "styles": {
        "line_color": "#e0b44c",
        "line_weight": 0.8,
        "d_line_m": 500,
        "d_line_color": "#967529",
        "d_weigth": 1,
        "smoothFactor": 1.7
      }
    },
    {
      "name": "Cota",
      "geoprocess": "waterRise",
      "namePrefix": "cota_",
      "layer": "geoprocesos:alos_unificado",
      "baseUrl": "https://imagenes.ign.gob.ar/geoserver/ows?service=WPS&version=1.0.0"
    },
    {
      "name": "Área de influencia",
      "geoprocess": "buffer",
      "namePrefix": "area_de_influencia_"
    },
    {
      "name": "Perfil de Elevación",
      "geoprocess": "elevationProfile",
      "namePrefix": "profile_"
    }
  ]
}

Analytics

analytics_ids
string[]
Array of analytics tracking IDs (e.g. Google Analytics measurement IDs). Leave as an empty array [] if you do not use analytics. Example: ["G-XXXXXXXXXX"].

UI strings

The strings object lets you override a handful of fixed UI labels without touching source code.
strings.basemap_legend_button_text
string
Label on the basemap legend button. Default: "Ver leyenda del mapa".
strings.basemap_min_zoom
string
Prefix text in the basemap zoom info tooltip. Default: "Zoom mínimo de ".
strings.basemap_max_zoom
string
Infix text in the basemap zoom info tooltip. Default: " y máximo de ".
strings.delete_geometry
string
Label on the “delete geometry” option in the context menu. Default: "Eliminar geometría".

Minimal complete example

The snippet below is a minimal but fully functional preferences.json derived from src/config/default/preferences.json. It includes every top-level key with representative values:
{
  "analytics_ids": [],
  "table": { "isActive": false, "rowsLimit": 5 },
  "charts": { "isActive": true },
  "layer_options": { "isActive": false },
  "metaTags": { "title": "", "description": "", "image": "" },
  "excluded_plugins": ["minimap"],
  "mapConfig": {
    "center": { "latitude": -40, "longitude": -59 },
    "zoom": { "initial": 4, "min": 3, "max": 21 }
  },
  "showSearchBar": true,
  "searchbar": {
    "isActive": true,
    "top": "5px",
    "left": "40%",
    "color_focus": "#008dc9",
    "background_color": "rgba(255, 255, 255, 0.7)",
    "strings": { "placeholder": "Buscar lugar..." }
  },
  "geocoder": {
    "url": "https://api.ign.gob.ar/buscador/",
    "search": "search",
    "url_by_id": "places",
    "query": "q",
    "lang": "es",
    "limit": 5,
    "key": ""
  },
  "referencias": {
    "show": false,
    "icon": "src/config/default/styles/images/referencias.png",
    "image": "src/config/styles/images/legends/referencias.png",
    "width": "25px",
    "height": "31px"
  },
  "theme": {
    "headerBackground": "#157DB9",
    "menuBackground": "#157DB9",
    "bodyBackground": "#0094d4",
    "activeLayer": "#33b560",
    "iconBar": "#4f4f4f",
    "btnColor": "#FFFFFF",
    "textLegendMenu": "#FFFFFF",
    "textLegendMenuStyle": "",
    "textMenu": "#FFFFFF",
    "textMenuStyle": ""
  },
  "logo": {
    "title": "Argenmap",
    "src": "src/styles/images/argenmap-banner-white.webp",
    "height": "",
    "width": "",
    "style": "background-size: 160px;",
    "srcLogoMini": "src/styles/images/argenmap-banner-white.webp",
    "miniHeight": "",
    "miniWidth": "",
    "ministyle": "filter: drop-shadow(1px 1px 1px #103847); width: 128px;",
    "link": "https://github.com/ign-argentina/argenmap"
  },
  "logoText": {
    "content": "",
    "title": "",
    "link": "#"
  },
  "title": "Argenmap",
  "website": "https://github.com/ign-argentina/argenmap",
  "favicon": "src/styles/images/favicon.ico",
  "hillshade": {
    "addTo": ["argenmap", "argenmap_gris"],
    "attribution": "sombra de montaña <a target='_blank' href='https://www.arcgis.com/home/item.html?id=1b243539f4514b6ba35e7d995890db1d'>©Esri</a>",
    "icon": "src/styles/images/mountains.svg",
    "name": "hillshade",
    "switchLabel": "Agregar sombra de montaña Esri",
    "url": "https://services.arcgisonline.com/arcgis/rest/services/Elevation/World_Hillshade/MapServer/tile/{z}/{y}/{x}.png"
  },
  "strings": {
    "basemap_min_zoom": "Zoom mínimo de ",
    "basemap_max_zoom": " y máximo de ",
    "basemap_legend_button_text": "Ver leyenda del mapa",
    "delete_geometry": "Eliminar geometría"
  },
  "onInit": {
    "showToolbar": true,
    "showLayerMenu": true
  },
  "geoprocessing": {
    "isActive": true,
    "availableProcesses": []
  }
}

Build docs developers (and LLMs) love