This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
thinkgeo.mapsuite.silverlightedition.overlay [2015/09/21 03:29] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.SilverlightEdition.Overlay ====== | ||
| - | Serves as the base class that defines the properties and methods shared by all types of overlays. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | ***ThinkGeo.MapSuite.SilverlightEdition.Overlay** | ||
| - | *[[ThinkGeo.MapSuite.SilverlightEdition.MarkerOverlay]] | ||
| - | *[[ThinkGeo.MapSuite.SilverlightEdition.BingMapsOverlay]] | ||
| - | *[[ThinkGeo.MapSuite.SilverlightEdition.WmsOverlay]] | ||
| - | *[[ThinkGeo.MapSuite.SilverlightEdition.InteractiveOverlay]] | ||
| - | *[[ThinkGeo.MapSuite.SilverlightEdition.LayerOverlay]] | ||
| - | *[[ThinkGeo.MapSuite.SilverlightEdition.OpenStreetMapOverlay]] | ||
| - | *[[ThinkGeo.MapSuite.SilverlightEdition.WmtsOverlay]] | ||
| - | *[[ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitWmsSilverlightOverlay]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ==== Protected Constructors ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Overlay() ** | ||
| - | |||
| - | This is constructor of Overlay class. | ||
| - | == Remarks == | ||
| - | This is constructor of Overlay class. | ||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Overlay(String) ** | ||
| - | |||
| - | This is constructor of Overlay class. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Parameters == | ||
| - | * //name// | ||
| - | * Type:String | ||
| - | * Description:A string value indicating the name of this overlay. | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} Refresh() ** | ||
| - | |||
| - | This method re-draws this overlay in current extent. | ||
| - | == Remarks == | ||
| - | This method re-draws this overlay in current extent. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * 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. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //currentMap// | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightEdition.Map|Map]] | ||
| - | * Description:Current map information. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] | ||
| - | * Description:A point shape in world coordinates. | ||
| - | |||
| - | == Parameters == | ||
| - | * //screenX// | ||
| - | * Type:Double | ||
| - | * Description:The X-value in pixels referenced to the screen origin. | ||
| - | |||
| - | * //screenY// | ||
| - | * Type:Double | ||
| - | * Description:The Y-value in pixels referenced to the screen origin. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] | ||
| - | * Description:A point shape in world coordinates. | ||
| - | |||
| - | == Parameters == | ||
| - | * //screenCoordinate// | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] | ||
| - | * Description:The point (in screen coordinates) to convert to world coordinates. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] | ||
| - | * Description:A point shape in world coordinates. | ||
| - | |||
| - | == Parameters == | ||
| - | * //screenCoordinate// | ||
| - | * Type:Point | ||
| - | * Description:The point (in screen coordinates) to convert to world coordinates. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] | ||
| - | * Description:A screen point in pixels. | ||
| - | |||
| - | == Parameters == | ||
| - | * //worldX// | ||
| - | * Type:Double | ||
| - | * Description:The X world coordinate. | ||
| - | |||
| - | * //worldY// | ||
| - | * Type:Double | ||
| - | * Description:The Y world coordinate. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] | ||
| - | * Description:A screen point in pixels. | ||
| - | |||
| - | == Parameters == | ||
| - | * //worldCoordinate// | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] | ||
| - | * Description:A point shape in world coordinates. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightCore.PointShape|PointShape]] | ||
| - | * Description:A screen point in pixels. | ||
| - | |||
| - | == Parameters == | ||
| - | * //worldCoordinate// | ||
| - | * Type:Point | ||
| - | * Description:A point in world coordinates. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{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. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{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 | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} ZoomStoryCompletedCore() ** | ||
| - | |||
| - | This method raised when zooming animation plays completed. | ||
| - | == Remarks == | ||
| - | This method raised when zooming animation plays completed. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} PanAnimationCompletedCore() ** | ||
| - | |||
| - | This method raised when Panning animation plays completed. | ||
| - | == Remarks == | ||
| - | This method raised when Panning animation plays completed. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} InitializeCore() ** | ||
| - | |||
| - | 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 == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} Visibility ** | ||
| - | |||
| - | Gets or sets a value that indicates whether the overlay is visible on the map. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Visibility | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} OverlayElement ** | ||
| - | |||
| - | An FrameworkElement that contains the overlay. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:FrameworkElement | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | |||
| - | Gets or sets the name of an overlay which will display in the OverlaySwitcher. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} TransitionEffect ** | ||
| - | |||
| - | Gets or Sets the transition effect to use when the map is panned or zoomed. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightEdition.TransitionEffect|TransitionEffect]] | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} Opacity ** | ||
| - | |||
| - | Gets or sets the opacity level of the overlay. | ||
| - | == Remarks == | ||
| - | The Opacity 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 == | ||
| - | * Type:Double | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:Int32 | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} StoryboardForZooming ** | ||
| - | |||
| - | Gets the Storyboard object for zooming. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Storyboard | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} StoryboardForPanning ** | ||
| - | |||
| - | Gets the Storyboard object for panning. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Storyboard | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} PanFrameX ** | ||
| - | |||
| - | Animates from the System.Double value of the previous key frame to its own System.Windows.Media.Animation.DoubleKeyFrame.Value using splined interpolation. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:SplineDoubleKeyFrame | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} PanFrameY ** | ||
| - | |||
| - | Animates from the System.Double value of the previous key frame to its own System.Windows.Media.Animation.DoubleKeyFrame.Value using splined interpolation. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:SplineDoubleKeyFrame | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomFrameX ** | ||
| - | |||
| - | Gets the SplineDoubleKeyFrame for zooming. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:SplineDoubleKeyFrame | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} ZoomFrameY ** | ||
| - | |||
| - | Gets the SplineDoubleKeyFrame for zooming. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:SplineDoubleKeyFrame | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} MapInfo ** | ||
| - | |||
| - | Gets or sets current map information. | ||
| - | == Remarks == | ||
| - | Gets or sets current map information. | ||
| - | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.SilverlightEdition.Map|Map]] | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} TranslateTransform ** | ||
| - | |||
| - | Gets the TranslateTransform object of this overlay. | ||
| - | == Remarks == | ||
| - | Gets the TranslateTransform object of this overlay. | ||
| - | == Return Value == | ||
| - | * Type:TranslateTransform | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} ScaleTransform ** | ||
| - | |||
| - | Gets the ScaleTransform object of this overlay. | ||
| - | == Remarks == | ||
| - | Gets the ScaleTransform object of this overlay. | ||
| - | == Return Value == | ||
| - | * Type:ScaleTransform | ||
| - | |||
| - | ** {{wiki:ProtectedProperty.gif|}} TransformGroup ** | ||
| - | |||
| - | Gets the TranslateGroup object for panning and zooming. | ||
| - | == Remarks == | ||
| - | Gets the TranslateGroup object for panning and zooming. | ||
| - | == 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]] | ||
| - | |||
8501 Wade Blvd Ste 550
Frisco, TX 75034
United States
sales@thinkgeo.com
1-785-727-4133
Online Store
- Desktop
WPF
WinForms
- Web
WebAPI HTML5/JavaScript
ASP.NET MVC
WebForms with AJAX
- Mobile
iOS
Android™
World Street
World Imagery
Routing
Geocoding
Reverse Geocoding
Elevation
Quick Start Guides
Documentation
Blogs
Discussion Forums
Customer Portal
About Us
News & Announcemets
Privacy Policy
Copyright 2003-2017 ThinkGeo LLC.
All rights reserved.