Navigation:  Introduction to WebOffice map widget > Supported Parameters > Map Display Parameters

Following parameters are necessary to display a map. (See chapter Request to get a dynamic Map Image for further infomration.)

 

•baseURL (mandatory): Base part of the end point URL to the WebOffice 10 R3 synservice servlet. If e.g. the WebOffice map widget default.htm page is accessible through http://<servername>:<port>/<webapplication>/client_preview/SynServiceClient/default.htm and the synservice servlet is accessible through URL http://<servername>:<port>/<webapplication>/synservice then use baseURL=http://<servername>:<port>/<webapplication> .

 

•project (mandatory): ID of the WebOffice 10 R3 project configuration to be used in WebOffice map widget.  If e.g. the WebOffice 10 R3 project Identifier is 'WebOfficeSampleProject' then use project=WebOfficeSampleProject .

 

•width (mandatory): Width of the requested map image in pixels. If e.g. the map image should have a width of 600 pixels then use width=600 .

 

•height (mandatory): Height of the requested map image in pixels. If e.g. the map image should have a height of 400 pixels then use height=400 .

 

•x: Center point x coordinate of the requested map in map units. This parameter must be used in conjunction with parameter y. If e.g. the requested map image should be centered at x coordinate 1083156.624 then use x=1083156.624 .

Note: As comma delimiter a „.“ must be used (local independent).

 

•y: Center point y coordinate of the requested map in map units. This parameter must be used in conjunction with parameter x. If e.g. the requested map image should be centered at y coordinate 6024173.425 then use y=6024173.425 .

Note: As comma delimiter a „.“ must be used (local independent).

 

•scale: Desired scale of the requested map. The returned scale might be different when using tiled maps (map caches) because in map caches only specific discrete scale levels are available. If e.g. the requested map image should have scale 1000 then use scale=1000 .

 

•view: Desired predefined map view. The external map view ID specified in the WebOffice 10 R3 project must be used as value for the view parameter. (See Representation Models / Map Views for how to configure map views.) If e.g. the requested map view is identified by OSM then use view=OSM .

 

•map_adv: To get information on the tiles (tile URL, offset, widht, height etc.).

 

•mapmargin: If using tiled map caches, then use this parameter to control the number of tiles to get preloaded in the area outside the currently visible map. This is useful if users do a lot of panning. Note, however, that increasing the value of the parameter mapmargin (default is 1) will increase the time needed for loading all tiles and will reduce performance and interactivity level of WebOffice map widget. If the user often sees blank map areas during panning then the mapmargin can be adjusted to e.g. mapmargin=2 .

Note: If the WebOffice map widget is displayed standalone using the default.htm it is possible to show the tile borders by pressing "c". Tiles are outlined blue if they are inside the current map extent, other pre-rendered tiles (defined by mapmargin) are outlined orange.

 

•maptransparency: Specifies if the last visible map image is displayed with a specific transparent level when it is getting updated. Default is 0, i.e. the last map is displayed opaque (no transparency). If the map (e.g. OSM) is not transparent at all then the default value 0 is OK because no transparency is needed. Valid values are [0..1], e.g. 0, 0.4 or 1. If e.g. the map transparency of the last map should be 40% then use maptransparency=0.4 .

Note: If you use dynamic map services or map services that are transparent set the parameter maptranparency either to 1 or quite close to 1 (0.9 or 0.8).

 

•osm_timeout_mw: The parameter osm_timeout_mw defines the time need for subdomain x to load OSM-tiles. If this period is  exceeded domain y will load the tiles. The default value is 3333 [ms].

Note: In case there are no OSM-tiles configured in the project, this parameter has no further impacts.

 

•geo_bookmark: The parameter geo_bookmark defines a kind of a bookmark to start a project with a certain, spatial extent. This geo bookmark has to be configured in the project (more details in Geo-Bookmark ). The value of the parameter geo_bookmark is the external ID, configured in WebOffice author. Example: The geo bookmark for Vienna with the external ID 'VIE' is called via geo_bookmark=VIE.

 

•exclude_north_and_scale: With the parameter &exclude_north_and_scale=true only a map image will be displayed. North arrow, scale bar and copyright will be supressed.