ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.windowsphoneedition.worldmapkitwmswindowsphoneoverlay
Table of Contents
ThinkGeo.MapSuite.WindowsPhoneEdition.WorldMapKitWmsWindowsPhoneOverlay
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
<!– Class –> This class represents an Overlay that retrieves tiles from ThinkGeo WorldMapKit Wms server.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay *ThinkGeo.MapSuite.WindowsPhoneEdition.WorldMapKitWmsWindowsPhoneOverlay
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 WorldMapKitWmsWindowsPhoneOverlay | This is constructor of WorldMapKitWmsWindowsPhoneOverlay class. | ||
| WorldMapKitWmsWindowsPhoneOverlay | String | This is constructor of WorldMapKitWmsWindowsPhoneOverlay class. | |
| WorldMapKitWmsWindowsPhoneOverlay | String, String | This is constructor of WorldMapKitWmsWindowsPhoneOverlay class. | |
| WorldMapKitWmsWindowsPhoneOverlay | String, String, String | This is constructor of WorldMapKitWmsWindowsPhoneOverlay class. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Draw | RectangleShape, OverlayDrawType | Overlay | Zooms the overlay only to the extent that you specify. |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetType | Object | ||
| Initialize | Map | Overlay | This method initializes the overlay canvas such as width, height and z-index for first time. |
| Refresh | Overlay | This method re-draws this overlay in current extent. | |
| ToScreenCoordinate | Point | Overlay | This method returns a screen point from a point shape in world coordinates. |
| ToScreenCoordinate | Double, Double | Overlay | This method returns a point shape in screen coordinates from the specified X, Y world coordinates. |
| ToScreenCoordinate | PointShape | Overlay | This method returns a screen point from a point shape in world coordinates. |
| ToString | Object | ||
| ToWorldCoordinate | PointShape | Overlay | This method returns a point shape in world coordinates from a ScreenPointF structure. |
| ToWorldCoordinate | Point | Overlay | This method returns a point shape in world coordinates from a ScreenPointF structure. |
| ToWorldCoordinate | Double, Double | Overlay | This method returns a point shape in world coordinates from the specified X, Y screen coordinates. |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 DrawCore | RectangleShape | Overlay(overriden) | This method draws the features in the specified extent. |
| Finalize | Object | ||
| GetTileUri | Uri, RectangleShape, Int32, Int32, Int32, Int32, Double | This method gets the specific tile's Uri string by which to get tile from Wms server. | |
| InitializeCore | Overlay(overriden) | This method initializes the overlay canvas such as width, height and z-index at first time. | |
| MemberwiseClone | Object | ||
| PanAnimationCompletedCore | Overlay | This method raised when Panning animation plays completed. | |
| ZoomStoryCompletedCore | Overlay(overriden) | Event triggers after zoom ended. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 ClientId | String | Gets or sets a value that is your Client Id. | |
| Name | String | Overlay | Gets or sets the name of an overlay which will display in the OverlaySwitcher. |
| Opacity | Double | Overlay | Gets or sets the opacity level of the overlay. |
| OverlayElement | FrameworkElement | Overlay | An FrameworkElement that contains the overlay. |
| PanFrameX | SplineDoubleKeyFrame | Overlay | Animates from the System.Double value of the previous key frame to its own System.Windows.Media.Animation.DoubleKeyFrame.Value using splined interpolation. |
| PanFrameY | SplineDoubleKeyFrame | Overlay | Animates from the System.Double value of the previous key frame to its own System.Windows.Media.Animation.DoubleKeyFrame.Value using splined interpolation. |
| PrivateKey | String | Gets or sets a value that is unique to your client ID, please keep your key secure. | |
| Projection | WorldMapKitProjection | Gets or sets a WorldMapKitProjection represents which projection will be used. | |
| StoryboardForPanning | Storyboard | Overlay | Gets the Storyboard object for panning. |
| StoryboardForZooming | Storyboard | Overlay | Gets the Storyboard object for zooming. |
| TileCache | NativeImageTileCache | ||
| TransitionEffect | TransitionEffect | Overlay | Gets or Sets the transition effect to use when the map is panned or zoomed. |
| Visibility | Visibility | Overlay | Gets or sets a value that indicates whether the overlay is visible on the map. |
| ZIndex | Int32 | Overlay | Get or set z-index of overlay, The value is bigger, and the order is higher. |
| ZoomFrameX | SplineDoubleKeyFrame | Overlay | Gets the SplineDoubleKeyFrame for zooming. |
| ZoomFrameY | SplineDoubleKeyFrame | Overlay | Gets the SplineDoubleKeyFrame for zooming. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 MapInfo | Map | Overlay | Gets or sets current map information. |
| ParametersCore | Dictionary<String,String> | Gets a dictionary whose items will be passed to the TileOverlay server as parameters, it'll be used in the derived classes. | |
| ScaleTransform | ScaleTransform | Overlay | Gets the ScaleTransform object of this overlay. |
| TransformGroup | TransformGroup | Overlay | Gets the TranslateGroup object for panning and zooming. |
| TranslateTransform | TranslateTransform | Overlay | Gets the TranslateTransform object of this overlay. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
WorldMapKitWmsWindowsPhoneOverlay()
This is constructor of WorldMapKitWmsWindowsPhoneOverlay class.
Overloads
This is constructor of WorldMapKitWmsWindowsPhoneOverlay class.
Remarks
This is constructor of <strong>WorldMapKitWmsWindowsPhoneOverlay</strong> class.
Parameters
| Name | Type | Description |
|---|
WorldMapKitWmsWindowsPhoneOverlay(String)
This is constructor of WorldMapKitWmsWindowsPhoneOverlay class.
Overloads
This is constructor of WorldMapKitWmsWindowsPhoneOverlay class.
Remarks
This is constructor of <strong>WorldMapKitWmsWindowsPhoneOverlay</strong> class.
Parameters
| Name | Type | Description |
|---|---|---|
| name | String<!– System.String –> | The name of the WorldMapKitWmsWindowsPhoneOverlay. |
WorldMapKitWmsWindowsPhoneOverlay(String, String)
This is constructor of WorldMapKitWmsWindowsPhoneOverlay class.
Overloads
This is constructor of WorldMapKitWmsWindowsPhoneOverlay class.
Remarks
This is constructor of <strong>WorldMapKitWmsWindowsPhoneOverlay</strong> class.
Parameters
| Name | Type | Description |
|---|---|---|
| clientId | String<!– System.String –> | The clientId for the WMS Server. |
| privateKey | String<!– System.String –> | The privateKey for the WMS Server. |
WorldMapKitWmsWindowsPhoneOverlay(String, String, String)
This is constructor of WorldMapKitWmsWindowsPhoneOverlay class.
Overloads
This is constructor of WorldMapKitWmsWindowsPhoneOverlay class.
Remarks
This is constructor of <strong>WorldMapKitWmsWindowsPhoneOverlay</strong> class.
Parameters
| Name | Type | Description |
|---|---|---|
| name | String<!– System.String –> | The name of the overlay. |
| clientId | String<!– System.String –> | The clientId for the WMS Server. |
| privateKey | String<!– System.String –> | The privateKey for the WMS Server. |
Protected Constructors
Public Methods
Draw(RectangleShape, OverlayDrawType)
Zooms the overlay only to the extent that you specify.
Remarks
The overlay will be panned to the center and zoomlevel of the extent that you specify.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| worldExtent | RectangleShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape –> | The new world extent of the map. |
| overlayDrawType | OverlayDrawType<!– ThinkGeo.MapSuite.WindowsPhoneEdition.OverlayDrawType –> | The enum value indecating that the map draws features or not. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Initialize(Map)
This method initializes the overlay canvas such as width, height and z-index for first time.
Remarks
This method initializes the overlay canvas such as width, height and z-index for first time.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| currentMap | Map<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Map –> | Current map information. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
Refresh()
This method re-draws this overlay in current extent.
Remarks
This method re-draws this overlay in current extent.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ToScreenCoordinate(Point)
This method returns a screen point from a point shape in world coordinates.
Remarks
This method converts the coordinates of a point shape to a point in screen coordinates.
Return Value
| Return Type | Description |
|---|---|
| PointShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.PointShape –> | A screen point in pixels. |
Parameters
| Name | Type | Description |
|---|---|---|
| worldCoordinate | Point<!– System.Windows.Point –> | A point in world coordinates. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ToScreenCoordinate(Double, Double)
This method returns a point shape in screen coordinates from the specified X, Y world coordinates.
Remarks
This method converts X, Y world coordinates to a point in screen coordinates.
Return Value
| Return Type | Description |
|---|---|
| PointShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.PointShape –> | A screen point in pixels. |
Parameters
| Name | Type | Description |
|---|---|---|
| worldX | Double<!– System.Double –> | The X world coordinate. |
| worldY | Double<!– System.Double –> | The Y world coordinate. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ToScreenCoordinate(PointShape)
This method returns a screen point from a point shape in world coordinates.
Remarks
This method converts the coordinates of a point shape to a point in screen coordinates.
Return Value
| Return Type | Description |
|---|---|
| PointShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.PointShape –> | A screen point in pixels. |
Parameters
| Name | Type | Description |
|---|---|---|
| worldCoordinate | PointShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.PointShape –> | A point shape in world coordinates. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ToWorldCoordinate(PointShape)
This method returns a point shape in world coordinates from a ScreenPointF structure.
Remarks
This method converts a screen point to a point in world coordinates.
Return Value
| Return Type | Description |
|---|---|
| PointShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.PointShape –> | A point shape in world coordinates. |
Parameters
| Name | Type | Description |
|---|---|---|
| screenCoordinate | PointShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.PointShape –> | The point (in screen coordinates) to convert to world coordinates. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ToWorldCoordinate(Point)
This method returns a point shape in world coordinates from a ScreenPointF structure.
Remarks
This method converts a screen point to a point in world coordinates.
Return Value
| Return Type | Description |
|---|---|
| PointShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.PointShape –> | A point shape in world coordinates. |
Parameters
| Name | Type | Description |
|---|---|---|
| screenCoordinate | Point<!– System.Windows.Point –> | The point (in screen coordinates) to convert to world coordinates. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ToWorldCoordinate(Double, Double)
This method returns a point shape in world coordinates from the specified X, Y screen coordinates.
Remarks
This method converts X, Y screen coordinates to a point shape in world coodinates.
Return Value
| Return Type | Description |
|---|---|
| PointShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.PointShape –> | A point shape in world coordinates. |
Parameters
| Name | Type | Description |
|---|---|---|
| screenX | Double<!– System.Double –> | The X-value in pixels referenced to the screen origin. |
| screenY | Double<!– System.Double –> | The Y-value in pixels referenced to the screen origin. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
Protected Methods
DrawCore(RectangleShape)
This method draws the features in the specified extent.
Remarks
This method draws the features in the specified extent.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| worldExtent | RectangleShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape –> | The new world extent of the map. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay(overriden) –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetTileUri(Uri, RectangleShape, Int32, Int32, Int32, Int32, Double)
This method gets the specific tile's Uri string by which to get tile from Wms server.
Return Value
| Return Type | Description |
|---|---|
| Uri<!– System.Uri –> | A Uri object. |
Parameters
| Name | Type | Description |
|---|---|---|
| serverUri | Uri<!– System.Uri –> | The Wms server's Uri. |
| tileExtent | RectangleShape<!– ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape –> | The world extent of tile. |
| row | Int32<!– System.Int32 –> | The row index in the tile matrix. |
| column | Int32<!– System.Int32 –> | The column index in the tile matrix. |
| tileWidth | Int32<!– System.Int32 –> | The width of tile. |
| tileHeight | Int32<!– System.Int32 –> | The height of tile. |
| scale | Double<!– System.Double –> | The scale of tile. |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.WorldMapKitWmsWindowsPhoneOverlay –> Go Back
InitializeCore()
This method initializes the overlay canvas such as width, height and z-index at first time.
Remarks
This method initializes the overlay canvas such as width, height and z-index at first time.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay(overriden) –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
PanAnimationCompletedCore()
This method raised when Panning animation plays completed.
Remarks
This method raised when Panning animation plays completed.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ZoomStoryCompletedCore()
Event triggers after zoom ended.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay(overriden) –> Go Back
Public Properties
ClientId
Gets or sets a value that is your Client Id.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.WorldMapKitWmsWindowsPhoneOverlay –> Go Back
Name
Gets or sets the name of an overlay which will display in the OverlaySwitcher.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
Opacity
Gets or sets the opacity level of the overlay.
Remarks
The <strong>Opacity</strong> property enables you to specify a level of transparency for the overlay. When this property is set to a value less than 100 percent(1.00), the entire overlay is made more transparent. Setting this property to a value of 0 percent (0.00) makes the overlay completely invisible.
Return Value
| Return Type |
|---|
| Double<!– System.Double –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
OverlayElement
An FrameworkElement that contains the overlay.
Return Value
| Return Type |
|---|
| FrameworkElement<!– System.Windows.FrameworkElement –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
PanFrameX
Animates from the System.Double value of the previous key frame to its own System.Windows.Media.Animation.DoubleKeyFrame.Value using splined interpolation.
Return Value
| Return Type |
|---|
| SplineDoubleKeyFrame<!– System.Windows.Media.Animation.SplineDoubleKeyFrame –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
PanFrameY
Animates from the System.Double value of the previous key frame to its own System.Windows.Media.Animation.DoubleKeyFrame.Value using splined interpolation.
Return Value
| Return Type |
|---|
| SplineDoubleKeyFrame<!– System.Windows.Media.Animation.SplineDoubleKeyFrame –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
PrivateKey
Gets or sets a value that is unique to your client ID, please keep your key secure.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.WorldMapKitWmsWindowsPhoneOverlay –> Go Back
Projection
Gets or sets a WorldMapKitProjection represents which projection will be used.
Return Value
| Return Type |
|---|
| WorldMapKitProjection<!– ThinkGeo.MapSuite.WindowsPhoneEdition.WorldMapKitProjection –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.WorldMapKitWmsWindowsPhoneOverlay –> Go Back
StoryboardForPanning
Gets the Storyboard object for panning.
Return Value
| Return Type |
|---|
| Storyboard<!– System.Windows.Media.Animation.Storyboard –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
StoryboardForZooming
Gets the Storyboard object for zooming.
Return Value
| Return Type |
|---|
| Storyboard<!– System.Windows.Media.Animation.Storyboard –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
TileCache
Return Value
| Return Type |
|---|
| NativeImageTileCache<!– ThinkGeo.MapSuite.WindowsPhoneCore.NativeImageTileCache –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.WorldMapKitWmsWindowsPhoneOverlay –> Go Back
TransitionEffect
Gets or Sets the transition effect to use when the map is panned or zoomed.
Return Value
| Return Type |
|---|
| TransitionEffect<!– ThinkGeo.MapSuite.WindowsPhoneEdition.TransitionEffect –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
Visibility
Gets or sets a value that indicates whether the overlay is visible on the map.
Return Value
| Return Type |
|---|
| Visibility<!– System.Windows.Visibility –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ZIndex
Get or set z-index of overlay, The value is bigger, and the order is higher.
Remarks
Get or set z-index of overlay, The value is bigger, and the order is higher.
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ZoomFrameX
Gets the SplineDoubleKeyFrame for zooming.
Return Value
| Return Type |
|---|
| SplineDoubleKeyFrame<!– System.Windows.Media.Animation.SplineDoubleKeyFrame –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ZoomFrameY
Gets the SplineDoubleKeyFrame for zooming.
Return Value
| Return Type |
|---|
| SplineDoubleKeyFrame<!– System.Windows.Media.Animation.SplineDoubleKeyFrame –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
Protected Properties
MapInfo
Gets or sets current map information.
Remarks
Gets or sets current map information.
Return Value
| Return Type |
|---|
| Map<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Map –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
ParametersCore
Gets a dictionary whose items will be passed to the TileOverlay server as parameters, it'll be used in the derived classes.
Return Value
| Return Type |
|---|
| Dictionary<String,String><!– System.Collections.Generic.Dictionary{System.String,System.String} –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.WorldMapKitWmsWindowsPhoneOverlay –> Go Back
ScaleTransform
Gets the ScaleTransform object of this overlay.
Remarks
Gets the ScaleTransform object of this overlay.
Return Value
| Return Type |
|---|
| ScaleTransform<!– System.Windows.Media.ScaleTransform –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
TransformGroup
Gets the TranslateGroup object for panning and zooming.
Remarks
Gets the TranslateGroup object for panning and zooming.
Return Value
| Return Type |
|---|
| TransformGroup<!– System.Windows.Media.TransformGroup –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
TranslateTransform
Gets the TranslateTransform object of this overlay.
Remarks
Gets the TranslateTransform object of this overlay.
Return Value
| Return Type |
|---|
| TranslateTransform<!– System.Windows.Media.TranslateTransform –> |
<!– ThinkGeo.MapSuite.WindowsPhoneEdition.Overlay –> Go Back
Public Events
thinkgeo.mapsuite.windowsphoneedition.worldmapkitwmswindowsphoneoverlay.txt · Last modified: 2017/03/16 21:59 (external edit)