mapfull

Description

Initializes Oskari core with Oskari.mapframework.service.MapLayerService, starts up Oskari.mapframework.ui.module.common.MapModule and renders the map to a HTML element with id "mapdiv".

The bundle doesn't create the "mapdiv" element but assumes it exists on the page. Adds maplayers to the map and moves it to a location and zoom level as specified in state.

Screenshot

Mapfull using mapmodule-plugin bundle to show map view with some plugins (scalebar, zoombar, wmslayer, panbuttons etc). SrsName projection can be configured if defined in projectionDefs. ProjectionDefs will replace the default projections "EPSG:3067" and "EPSG:4326". SrsName "EPSG:3067" is used by default.

Bundle configuration

{
    "mapOptions" : {
        "resolutions" : [8192, 4096, 2048, 1024, 512, 256, 128, 64, 32, 16, 8, 4, 2, 1, 0.5, 0.25],
        "maxExtent" : {
            "left" : -548576.0,
            "bottom" : 6291456.0,
            "right" : 1548576.0,
            "top" :  8388608
        },
        "units" : "m",
        "srsName" : "EPSG:3067"
    },
    "projectionDefs" : {
        "EPSG:3067" : "+proj=utm +zone=35 +ellps=GRS80 +units=m +no_defs",
        "EPSG:4326" : "+title=WGS 84 +proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs"
    },
  "plugins":[
    {
      "id":"Oskari.mapframework.bundle.mapmodule.plugin.LayersPlugin"
    },
    {
      "id":"Oskari.mapframework.mapmodule.WmsLayerPlugin"
    },
    {
      "id":"Oskari.mapframework.mapmodule.ControlsPlugin"
    }
  ],
  "layers":[
    {
      <1 or more layer definitions, should have at least ones referenced in state.selectedLayers>
    }
  ],
  "globalMapAjaxUrl":"{{url for ajax operations}}",
  "user":{
     <logged in users details for Oskari.User >
  },
  "imageLocation":"{{base url mapmodulen for images(optional, defaults to  "/Oskari/resources")}}",
  "mapElement": "{{DOM element id for OpenLayers map, defaults to 'mapdiv'}}",
  "mapContainer": "{{DOM element id for Oskari map container, defaults to 'contentMap'}}",
  "size": {
    "width" : <map window width>,
    "height" : <map window height>
  }
}

• plugins is an array of map module plugins that will be registered and started on map when the bundle is started. If you specify no plugins, you wont see anything on the map. See different plugins documentation to see which ones you should have here.
• layers is an array of map layer JSON definitions that will be populated to Oskari.mapframework.service.MapLayerService. It can have 0 or more layer definitions but it SHOULD have at least the ones referenced in state.selectedLayers. Otherwise selectedLayers aren't going to be added to map on startup.
• globalMapAjaxUrl is set to Oskari.Sandbox and can be asked everywhere with sandbox.getAjaxUrl()
• mapOptions is passed to mapmodule-plugin constructor
• user is optional and should have information about the logged in user. It can be asked everywhere with Oskari.user(). The format of the data should in a form accepted by Oskari.User constructor.
• size is optional but if given will set the map elements size. If size isn't specified the map elements height will be set to window height and the bundle will listen to window resizing to adjust the map size.

Bundle state

{
  "selectedLayers": [
    {
      "id": "{{id of a preselected layer}}",
      "hidden" : "{{boolean (optional)}}",
      "style" : "{{style name (optional)}}",
      "opacity" : "{{layer opacity (optional)}}"
    }
  ],
  "zoom": "{{zoomlevel 0-12}}",
  "east": "{{latitude}}",
  "north": "{{longitude}}",
  "camera": {
    "orientation": {
      "heading": 0,
      "roll": 0,
      "pitch": -65
    },
    "location": {
      "altitude": 1500000,
      "x": 2762500,
      "y": 7835000
    }
  }
}

• selectedLayers is an array specifying which layers should be added to map on startup. It can have only id property, but other listed properties are supported as well.
• camera setting is available only in mapmodules with 3D support

Requests the bundle handles

Requests the bundle sends out

Events the bundle listens to

This bundle doesn't listen to any events, but initializes Oskari.mapframework.ui.module.common.MapModule which listens to many events.

Events the bundle sends out

This bundle doesn't send out any events, but initializes Oskari.mapframework.core.Core, Oskari.mapframework.service.MapLayerService, Oskari.mapframework.ui.module.common.MapModule which send out many events.

Dependencies