MapsWidget

Props passed to widget

• current_user_iam
  User logged in IAM

  current_user User logged in application

• context_path
  The path to be pre-appended to the URL paths used in the requests.

  Ex.

  basiccore
  

• base_url
  The API URL of "maps" to be used when the widget is loaded within an application with a domain different from that of maps.

  Ex.

  https:/deve-mapsview.civis.bz.it
  

• context_identifier
  Identifier of the context to load. It is possible to provide the identifier instead of the entire context configuration.
  The widget will make the appropriate request to the server to obtain the correct configuration.
  It is not necessary to pass the "context_configs" parameter to the widget.

• context_configs
  Context configurations to run widget. For details of this configurations see response of maps API:

  /maps/api/v1/contexts/<context_identifier>
  

• language
  Language to localized widget

  Ex.

  it
  

• initial_extent
  Initial extent of the map

  [<minX>, <minY, <maxX>, <maxY>]
  

• initial_extent_epsg
  Coordinate system of initial extent

  Ex.

  EPSG:25832
  

• filtered_layers
  Layers of the context to load that can not be visualized

  Ex.

  {
    contexts: ['BC-BASIC-CORE'],
    identifiers: ['PROV-ADMINISTRATIVE-UNITS-MUNICIPALITIES'],
  }
  

• cmp_configs
  Tools and widgets configurations
  This JSON configuration defines the component settings (cmpConfigs) for a mapping or GIS web application. It specifies which features, tools, and behaviors should be enabled or customized in different parts of the application, such as overview maps, catalogs, tools, and layer controls (TOC – Table of Contents). Here's a breakdown of its structure and functionality:

Top-Level Keys in cmpConfigs:

1. overview

• Purpose: Sets the base layer for the overview map (typically a mini-map or context map).

• Key:

  • layerIdentifier: Uses layer as the background layer.

2. catalogs

• Purpose: Manages the visibility and availability of layer and data catalogs displayed on the left side of the widget interface.

• Keys:

  • enabled: Activates catalogs in the desktop version of the application
  • mobile: Specifies which catalogs are available when the application is used on mobile devices.

3. tools

• Purpose: Defines which map tools are available to the user.

• Keys:

  • enabled: List of desktop tools like:

    • drawMeasure: Drawing and measuring on the map
    • selection: Spatial or attribute-based selection
    • identifyMap: Identify features on the map
    • printMap: Print the current map view
    • downloadMap: Download the map as an image or file
    • downloadLayer: Download geodata
    • editingMap: Edit spatial features
    • geoprocess: Run geospatial processing functions
    • timeseriesTool: Time slider for temporal data
    • externalThemes: Add external WMS Themes

  • default: Index in the enabled list marks the default active

  • mobile: specifies which map tool are available when the application is used on mobile devices.

4. functions

• Purpose: Activates additional application-wide features accessible through various submenus within the application.

• Keys:

  • enabled: List of desktop tools like:

    • fnBaseMaps: Switch between base maps
    • fnViewTools: Toggle map view tools
    • fnMasterDetails: Use master-detail UI layout
    • fnDocumentsRead, fnDocumentsWrite: Document management (read/write)
    • fnExportData: Exporting data
    • fnImportData: Importing data
    • fnScalebar: Show scale bar
    • fnSearch: Search capabilities
    • fnLocation: Geolocation tools
    • fnGoogleStreetView: Integration with Google Street View
    • fn3dView: 3D map viewing
    • fnViewTools: 2D map viewing tools

5. toc (Table of Contents)

• Purpose: Manages available tools for each layer in the layer list panel.

• Keys:

  • tools.enabled: For desktop, includes:

    • infoLayer: View metadata or description
    • layerLegend: Show legend
    • filterLayer: Filter data within layer
    • layerTransparency: Adjust layer opacity
    • removeLayer: Remove the layer
    • shortInfo: Show short information tooltip
    • downloadLayer: Download layer data
    • zoomToExtent: Download layer data

  • tools.mobile: specifies which map tool are available when the application is used on mobile devices.

  ---

  Ex.

  cmpConfigs: {
    overview: {
      layerIdentifier: "PROV-BASEMAP-STANDARD",
    },
    catalogs: {
      enabled: ['contextCatalog','geoCatalog'],
      mobile: ['contextCatalog']
    },
    tools: {
      enabled: ['drawMeasure','selection','identifyMap','printMap','downloadMap','downloadLayer','editingMap','geoprocess','timeseriesTool'],
      default: 2,
      mobile: ['identifyMap']
    },
    functions: {
      enabled: ['fnBaseMaps','fnViewTools','fnMasterDetails','fnDocumentsRead','fnDocumentsWrite','fnExportData','fnImportData','fnScalebar','fnSearch','fnLocation','fnGoogleStreetView','fn3dView']
    },
    toc: {
      tools: {
        enabled: ['infoLayer','layerLegend','filterLayer','layerTransparency','removeLayer','shortInfo', 'downloadLayer'],
        mobile: ['layerLegend','layerTransparency','removeLayer', 'shortInfo']
      }
    }
  }
  

• territory
  Territory parameter: This parameter consists of two values separated by a colon (:).

  • Territory name
  • Territory id (code)

  Ex.

  MUNICIPALITY:21001
  

• maps_api_env
  Env code of maps api envinment to use.

  DEV - TEST - DEMO - PROD
  

• panel_tools_catalogs_visible
  Boolean parameter to show or hide the buttons of tools and themes panel.

  Ex.

  true
  

• panel_active_themes_visible
  Boolean parameter to show or not the right panel that shows active themes.

  Ex.

  true
  

• ctrl_zoom
  Boolean parameter to enable the Zoom In/Out function on the map with ctrl + scroll.

  Ex.

  true
  

• disable_identify_display
  Boolean parameter to disable the display of identifying information in the template elements
  of some components (e.g., Map.vue, IdentifyTool.vue) for the selected layers.

  Ex.

  true
  

• enable_search_event
  Boolean parameter to enable the event generated by selecting an item from the search results. If not defined, event is disabled by default.

  Ex.

  true