IMap Interface |
This the root interface of the map control. It is implemented both for WpfMap and FormsMap. The
interface has methods for setting and getting the current map viewport, configuring the gadgets and getting
access to the layers collection.
Namespace: Ptv.XServer.Controls.Map
Assembly: Ptv.XServer.Controls.Map (in Ptv.XServer.Controls.Map.dll) Version: 1.7.10.0
SyntaxThe IMap type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Center | Gets or sets the center of the map in WGS84 coordinates. |
| CoordinateDiplayFormat | Gets or sets the display format for coordinates. |
| CurrentCenter | Gets the center of the map in WGS84 coordinates while it is in animation mode. |
| CurrentScale | Gets the current scale of the map in meters per pixel while it is in animation mode. |
| CurrentZoomLevel | Gets the current zoom level of the map while it is in animation mode. |
| FitInWindow | Gets or sets a value indicating whether the map should be fitted in the window or not. |
| InvertMouseWheel | Gets or sets a value indicating whether the orientation for mouse-wheel zoom is inverted. If so,
zoom in and zoom out mouse wheel direction is exchanged. The default value is false. |
| IsAnimating | Gets a value indicating whether an animation is in progress. Returns true while the map performs
a transition to a new map section. |
| Layers | Gets the collection of map layers. |
| MaxZoom | Gets or sets the maximal level of detail according to the standard tiling scheme. The current
detail level (see ZoomLevel property) is corrected, if it is higher than the new maximum value. |
| MetersPerPixel | Gets the number of meters spanned by one pixel. |
| MinZoom | Gets or sets the minimal level of detail according to the standard tiling scheme. The current
detail level (see ZoomLevel property) is corrected, if it is lower than the new minimum value. |
| MouseDoubleClickZoom | Gets or sets the activation for zoom on double-click. If true, the user can zoom-in be double left-click
and zoom-out by double right-click. |
| MouseDragMode | Gets or sets the behavior when dragging the mouse while holding the left button. |
| MouseWheelSpeed | Gets or sets the speed for mouse-wheel zoom. The value defines the number of map zoom levels per
wheel delta. The default value is 0.5. |
| Scale | Gets the scale of the map in meters per pixel. |
| ToolTipManagement | Gets the object providing all functionality relevant for tool tip management. |
| UseAnimation | Gets or sets a value indicating whether the map uses transitions for panning, zooming and fade-in
of tiles. The default value is true. |
| UseMiles | Gets or sets a value indicating whether the scale unit is miles. The default value is false. |
| Xmap2LayerFactory | Gets the helper object for integration of XMap2 layers and Feature Layers of XServer 2.
The reference is only set when property XMapUrl is set with an XMap2 conform URL. |
| XMapCopyright | Gets or sets the copyright text. |
| XMapCredentials | Gets or sets the credentials for xMapServer basic HTTP authentication.
The format of the credential string is "<user>:<password>". |
| XMapStyle | Gets or sets the style profile of the xMapServer base map. |
| XMapUrl | Gets or sets the url pointing to where the xMapServer is located (e.g. http://127.0.0.1:50010/xmap/ws/XMap). |
| ZoomLevel | Gets or sets the zoom level of the map. |
Methods| Name | Description | |
|---|---|---|
 | GeoAsRelToMapView(Point) | Converts a geographic point to a point in WPF units. |
| GeoAsRelToMapView(Point, String) | Converts a geographic point to a point in WPF units. |
| GetCurrentEnvelope | Gets the bounding box of the visible map section while the map is in animation mode. |
| GetCurrentEnvelope(String) | Gets the bounding box of the visible map section while the map is in animation mode. |
| GetEnvelope | Gets the anticipated bounding box of the visible map section after the map was in animation mode / the
current box while the map is in animation mode. |
| GetEnvelope(String) | Gets the anticipated bounding box of the visible map section after the map was in animation mode / the
current box while the map is in animation mode. The bounding box coordinates are specified in a coordinate format
according the parameter value of spatialReferenceId. |
| MouseToGeo(MouseEventArgs) | Converts the click point of the mouse event to a geographic point in WGS84 units.
The click point of the mouse is determined relative to the map. |
| MouseToGeo(MouseEventArgs, String) | Converts the click point of the mouse event to a geographic point corresponding to the given
spatial reference id. The click point of the mouse is determined relative to the map. |
| PrintMap | Prints the currently displayed map. |
| RelToMapViewAsGeo(Point) | Converts a point from WPF coordinates to a geographic point. |
| RelToMapViewAsGeo(Point, String) | Converts a point from WPF coordinates to a geographic point. |
| SetEnvelope(MapRectangle) | Centers the map resulting in all elements within the specified rectangle are visible. |
| SetEnvelope(MapRectangle, String) | Centers the map, so all elements within the specified rectangle are visible. |
| SetMapLocation(Point, Double) | Sets the center (specified in WGS84 units) and zoom level of the map. |
| SetMapLocation(Point, Double, String) | Sets the center (coordinate format specified in parameter spatialReferenceId) and zoom level of the map. |
Events| Name | Description | |
|---|---|---|
 | ViewportBeginChanged | Event indicating the beginning of a change of the visible map section. This event is intended for
more longtime actions (for example reading DB-objects), when the map section will change. |
| ViewportEndChanged | Event indicating the ending of a change of the visible map section. It is the counterpart of the
event. |
| ViewportWhileChanged | Event indicating an intermediate view, when animation mode is active. It can be used to adapt the
size of WPF objects, or other actions, which are not time-consuming. This event may called multiple times,
when animation mode is active. |
See Also