====== ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitWmsSilverlightOverlay ====== {{section>upgrade_map_suite_to_10.0}} This class represents an Overlay that retrieves tiles from ThinkGeo WorldMapKit Wms server. ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.SilverlightEdition.Overlay ***ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitWmsSilverlightOverlay** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} WorldMapKitWmsSilverlightOverlay() ** * //This is constructor of WorldMapKitWmsSilverlightOverlay class.// == Remarks == * //This is constructor of WorldMapKitWmsSilverlightOverlay class.// == Parameters ==
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsSilverlightOverlay(WorldMapKitLayerType) ** * //N/A// == Remarks == * //N/A// == Parameters == * //layerType// * Type:[[ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitLayerType|WorldMapKitLayerType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsSilverlightOverlay(String) ** * //This is constructor of WorldMapKitWmsSilverlightOverlay class.// == Remarks == * //This is constructor of WorldMapKitWmsSilverlightOverlay class.// == Parameters == * //name// * Type:String * Description:The name of the WorldMapKitWmsSilverlightOverlay.
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsSilverlightOverlay(String,String) ** * //This is constructor of WorldMapKitWmsSilverlightOverlay class.// == Remarks == * //This is constructor of WorldMapKitWmsSilverlightOverlay class.// == Parameters == * //clientId// * Type:String * Description:The clientId for the WMS Server. * //privateKey// * Type:String * Description:The privateKey for the WMS Server.
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsSilverlightOverlay(String,String,String) ** * //N/A// == Remarks == * //N/A// == Parameters == * //name// * Type:String * Description:N/A * //clientId// * Type:String * Description:N/A * //privateKey// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsSilverlightOverlay(WorldMapKitLayerType,String,String) ** * //N/A// == Remarks == * //N/A// == Parameters == * //layerType// * Type:[[ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitLayerType|WorldMapKitLayerType]] * Description:N/A * //clientId// * Type:String * Description:N/A * //privateKey// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} WorldMapKitWmsSilverlightOverlay(String,WorldMapKitLayerType,String,String) ** * //This is constructor of WorldMapKitWmsSilverlightOverlay class.// == Remarks == * //This is constructor of WorldMapKitWmsSilverlightOverlay class.// == Parameters == * //name// * Type:String * Description:The name of the WorldMapKitWmsSilverlightOverlay. * //layerType// * Type:[[ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitLayerType|WorldMapKitLayerType]] * Description:N/A * //clientId// * Type:String * Description:The clientId for the WMS Server. * //privateKey// * Type:String * Description:The privateKey for the WMS Server.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} Initialize(Map) ** * //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 == * Type:Void * Description:N/A == Parameters == * //currentMap// * Type:[[ThinkGeo.MapSuite.SilverlightEdition.Map|Map]] * Description:Current map information.
** {{wiki:PublicMethod.gif|}} Draw(RectangleShape,OverlayDrawType) ** * //This method draws the features in the specified extent.// == Remarks == * //This method draws the features in the specified extent.// == Return Value == * Type:Void * Description:N/A == Parameters == * //worldExtent// * Type:[[ThinkGeo.MapSuite.SilverlightCore.RectangleShape|RectangleShape]] * Description:The new world extent of the map. * //overlayDrawType// * Type:[[ThinkGeo.MapSuite.SilverlightEdition.OverlayDrawType|OverlayDrawType]] * Description:The enum value indecating that the map draws features or not.
** {{wiki:PublicMethod.gif|}} Refresh() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(Double,Double) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] * Description:N/A == Parameters == * //screenX// * Type:Double * Description:N/A * //screenY// * Type:Double * Description:N/A
** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(PointShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] * Description:N/A == Parameters == * //screenCoordinate// * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} ToWorldCoordinate(Point) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] * Description:N/A == Parameters == * //screenCoordinate// * Type:Point * Description:N/A
** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(Double,Double) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] * Description:N/A == Parameters == * //worldX// * Type:Double * Description:N/A * //worldY// * Type:Double * Description:N/A
** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(PointShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] * Description:N/A == Parameters == * //worldCoordinate// * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} ToScreenCoordinate(Point) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] * Description:N/A == Parameters == * //worldCoordinate// * Type:Point * Description:N/A
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} 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 == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} ZoomStoryCompletedCore() ** * //Event triggers after zoom ended.// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawCore(RectangleShape) ** * //This method draws the features in the specified extent.// == Remarks == * //This method draws the features in the specified extent.// == Return Value == * Type:Void * Description:N/A == Parameters == * //worldExtent// * Type:[[ThinkGeo.MapSuite.SilverlightCore.RectangleShape|RectangleShape]] * Description:The new world extent of the map.
** {{wiki:ProtectedMethod.gif|}} 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.// == Remarks == * //N/A// == Return Value == * Type:Uri * Description:A Uri object. == Parameters == * //serverUri// * Type:Uri * Description:The Wms server's Uri. * //tileExtent// * Type:[[ThinkGeo.MapSuite.SilverlightCore.RectangleShape|RectangleShape]] * Description:The world extent of tile. * //row// * Type:Int32 * Description:The row index in the tile matrix. * //column// * Type:Int32 * Description:The column index in the tile matrix. * //tileWidth// * Type:Int32 * Description:The width of tile. * //tileHeight// * Type:Int32 * Description:The height of tile. * //scale// * Type:Double * Description:The scale of tile.
** {{wiki:ProtectedMethod.gif|}} LxU=(RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extent// * Type:[[ThinkGeo.MapSuite.SilverlightCore.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DxU=(GeoCanvas) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.SilverlightCore.GeoCanvas|GeoCanvas]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.SilverlightCore.GeoCanvas|GeoCanvas]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.SilverlightEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.SilverlightEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} PanAnimationCompletedCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} ClientId ** Gets or sets a value that is your Client Id. == Remarks == N/A == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} PrivateKey ** Gets or sets a value that is unique to your client ID, please keep your key secure. == Remarks == N/A == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Projection ** Gets or sets a WorldMapKitProjection represents which projection will be used. == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitProjection|WorldMapKitProjection]] ** {{wiki:PublicProperty.gif|}} LayerType ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitLayerType|WorldMapKitLayerType]] ** {{wiki:PublicProperty.gif|}} MapType ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitMapType|WorldMapKitMapType]] ** {{wiki:PublicProperty.gif|}} Visibility ** N/A == Remarks == N/A == Return Value == * Type:Visibility ** {{wiki:PublicProperty.gif|}} OverlayElement ** N/A == Remarks == N/A == Return Value == * Type:FrameworkElement ** {{wiki:PublicProperty.gif|}} Name ** N/A == Remarks == N/A == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Attribution ** N/A == Remarks == N/A == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} TransitionEffect ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightEdition.TransitionEffect|TransitionEffect]] ** {{wiki:PublicProperty.gif|}} Opacity ** N/A == Remarks == N/A == Return Value == * Type:Double ** {{wiki:PublicProperty.gif|}} ZIndex ** N/A == Remarks == N/A == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} StoryboardForZooming ** N/A == Remarks == N/A == Return Value == * Type:Storyboard ** {{wiki:PublicProperty.gif|}} StoryboardForPanning ** N/A == Remarks == N/A == Return Value == * Type:Storyboard ** {{wiki:PublicProperty.gif|}} PanFrameX ** N/A == Remarks == N/A == Return Value == * Type:SplineDoubleKeyFrame ** {{wiki:PublicProperty.gif|}} PanFrameY ** N/A == Remarks == N/A == Return Value == * Type:SplineDoubleKeyFrame ** {{wiki:PublicProperty.gif|}} ZoomFrameX ** N/A == Remarks == N/A == Return Value == * Type:SplineDoubleKeyFrame ** {{wiki:PublicProperty.gif|}} ZoomFrameY ** N/A == Remarks == N/A == Return Value == * Type:SplineDoubleKeyFrame ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} ParametersCore ** Gets a dictionary whose items will be passed to the TileOverlay server as parameters, it'll be used in the derived classes. == Remarks == N/A == Return Value == * Type:Dictionary ** {{wiki:ProtectedProperty.gif|}} MapInfo ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.SilverlightEdition.Map|Map]] ** {{wiki:ProtectedProperty.gif|}} TranslateTransform ** N/A == Remarks == N/A == Return Value == * Type:TranslateTransform ** {{wiki:ProtectedProperty.gif|}} ScaleTransform ** N/A == Remarks == N/A == Return Value == * Type:ScaleTransform ** {{wiki:ProtectedProperty.gif|}} TransformGroup ** N/A == Remarks == N/A == Return Value == * Type:TransformGroup ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.SilverlightEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.SilverlightEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]