ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.silverlightedition.overlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.SilverlightEdition.Overlay
<!– Class –> Serves as the base class that defines the properties and methods shared by all types of overlays.
Remarks
The <strong>Overlay</strong> has the similar concept as the layer. Different types of overlays stack over each other to form a map. An overlay object is responsible for getting the configuration infomation from the user and serialized to a json string to control the client javascript library to create appropriate client layer.
Usually an overlay represents an image with transparent background that is laid upon other overlay such as <strong>LayerOverlay</strong>, <strong>WmsOverlay</strong>. While the <strong>MarkerOverlay</strong> will not be rendered as an image, it is actually represents a <strong>div</strong> that holds bunch of marker images at client side.
There are basically two kinds of overlay: base overlay and non-base overlay.
The base overlay has its <strong>IsBaseOverlay</strong> property set to true. It is displayed as the background image of the map. In an <strong>OverlaySwither</strong>, there is a radio button beside its name. There can only be one base overlay be displayed at a time. You can click the radio button to switch the base overlay to show.
The non-base overlay has a false <strong>IsBaseOverlay</strong> property. These overlays can overlap on the base overlay or on themselves each other. They are displayed in the <strong>OverlaySwither</strong> with a check box beside their name. You can click the check box to show or hide that overlay.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.SilverlightEdition.Overlay *ThinkGeo.MapSuite.SilverlightEdition.BingMapsOverlay *ThinkGeo.MapSuite.SilverlightEdition.EditInteractiveOverlay *ThinkGeo.MapSuite.SilverlightEdition.ExtentInteractiveOverlay *ThinkGeo.MapSuite.SilverlightEdition.GoogleOverlay *ThinkGeo.MapSuite.SilverlightEdition.InMemoryMarkerOverlay *ThinkGeo.MapSuite.SilverlightEdition.InteractiveOverlay *ThinkGeo.MapSuite.SilverlightEdition.LayerOverlay *ThinkGeo.MapSuite.SilverlightEdition.MarkerOverlay *ThinkGeo.MapSuite.SilverlightEdition.OpenStreetMapOverlay *ThinkGeo.MapSuite.SilverlightEdition.ServerLayerOverlay *ThinkGeo.MapSuite.SilverlightEdition.SimpleMarkerOverlay *ThinkGeo.MapSuite.SilverlightEdition.TiledWmsOverlay *ThinkGeo.MapSuite.SilverlightEdition.TrackInteractiveOverlay *ThinkGeo.MapSuite.SilverlightEdition.WmsOverlay *ThinkGeo.MapSuite.SilverlightEdition.WmtsOverlay ***ThinkGeo.MapSuite.SilverlightEdition.WorldMapKitWmsSilverlightOverlay
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Draw | RectangleShape, OverlayDrawType | Zooms the overlay only to the extent that you specify. | |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetType | Object | ||
| Initialize | Map | This method initializes the overlay canvas such as width, height and z-index for first time. | |
| Refresh | This method re-draws this overlay in current extent. | ||
| ToScreenCoordinate | PointShape | This method returns a screen point from a point shape in world coordinates. | |
| ToScreenCoordinate | Double, Double | This method returns a point shape in screen coordinates from the specified X, Y world coordinates. | |
| ToScreenCoordinate | Point | This method returns a screen point from a point shape in world coordinates. | |
| ToString | Object | ||
| ToWorldCoordinate | PointShape | This method returns a point shape in world coordinates from a ScreenPointF structure. | |
| ToWorldCoordinate | Double, Double | This method returns a point shape in world coordinates from the specified X, Y screen coordinates. | |
| ToWorldCoordinate | Point | This method returns a point shape in world coordinates from a ScreenPointF structure. |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 DrawAttributionCore | GeoCanvas | ||
| DrawCore | RectangleShape | This method draws the features in the specified extent. | |
| Finalize | Object | ||
| InitializeCore | This method initializes the overlay canvas such as width, height and z-index for first time. | ||
| MemberwiseClone | Object | ||
| OnDrawingAttribution | DrawingAttributionOverlayEventArgs | ||
| OnDrawnAttribution | DrawnAttributionOverlayEventArgs | ||
| PanAnimationCompletedCore | This method raised when Panning animation plays completed. | ||
| ZoomStoryCompletedCore | This method raised when zooming animation plays completed. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Attribution | String | ||
| Name | String | Gets or sets the name of an overlay which will display in the OverlaySwitcher. | |
| Opacity | Double | Gets or sets the opacity level of the overlay. | |
| OverlayElement | FrameworkElement | An FrameworkElement that contains the overlay. | |
| PanFrameX | SplineDoubleKeyFrame | 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 | Animates from the System.Double value of the previous key frame to its own System.Windows.Media.Animation.DoubleKeyFrame.Value using splined interpolation. | |
| StoryboardForPanning | Storyboard | Gets the Storyboard object for panning. | |
| StoryboardForZooming | Storyboard | Gets the Storyboard object for zooming. | |
| TransitionEffect | TransitionEffect | Gets or Sets the transition effect to use when the map is panned or zoomed. | |
| Visibility | Visibility | Gets or sets a value that indicates whether the overlay is visible on the map. | |
| ZIndex | Int32 | Get or set z-index of overlay, The value is bigger, and the order is higher. | |
| ZoomFrameX | SplineDoubleKeyFrame | Gets the SplineDoubleKeyFrame for zooming. | |
| ZoomFrameY | SplineDoubleKeyFrame | Gets the SplineDoubleKeyFrame for zooming. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 MapInfo | Map | Gets or sets current map information. | |
| ScaleTransform | ScaleTransform | Gets the ScaleTransform object of this overlay. | |
| TransformGroup | TransformGroup | Gets the TranslateGroup object for panning and zooming. | |
| TranslateTransform | TranslateTransform | Gets the TranslateTransform object of this overlay. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 DrawingAttribution | DrawingAttributionOverlayEventArgs | ||
| DrawnAttribution | DrawnAttributionOverlayEventArgs |
Public Constructors
Protected Constructors
Overlay()
This is constructor of Overlay class.
Overloads
This is constructor of Overlay class.
Remarks
This is constructor of <strong>Overlay</strong> class.
Parameters
| Name | Type | Description |
|---|
Overlay(String)
This is constructor of Overlay class.
Overloads
This is constructor of Overlay class.
Parameters
| Name | Type | Description |
|---|---|---|
| name | String<!– System.String –> | A string value indicating the name of this overlay. |
Public Methods
Draw(RectangleShape, OverlayDrawType)
Zooms the overlay only to the extent that you specify.
Overloads
Zooms the overlay 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.SilverlightCore.RectangleShape –> | The new world extent of the map. |
| overlayDrawType | OverlayDrawType<!– ThinkGeo.MapSuite.SilverlightEdition.OverlayDrawType –> | The enum value indecating that the map draws features or not. |
<!– ThinkGeo.MapSuite.SilverlightEdition.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.SilverlightEdition.Map –> | Current map information. |
<!– ThinkGeo.MapSuite.SilverlightEdition.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.SilverlightEdition.Overlay –> Go Back
ToScreenCoordinate(PointShape)
This method returns a screen point from a point shape in world coordinates.
Overloads
This method returns a screen point that is converted from the specified 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.SilverlightCore.PointShape –> | A screen point in pixels. |
Parameters
| Name | Type | Description |
|---|---|---|
| worldCoordinate | PointShape<!– ThinkGeo.MapSuite.SilverlightCore.PointShape –> | A point shape in world coordinates. |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
ToScreenCoordinate(Double, Double)
This method returns a point shape in screen coordinates from the specified X, Y world coordinates.
Overloads
This method returns a screen point that is converted from the specified world coordinates.
Remarks
This method converts X, Y world coordinates to a point in screen coordinates.
Return Value
| Return Type | Description |
|---|---|
| PointShape<!– ThinkGeo.MapSuite.SilverlightCore.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.SilverlightEdition.Overlay –> Go Back
ToScreenCoordinate(Point)
This method returns a screen point from a point shape in world coordinates.
Overloads
This method returns a screen point that is converted from the specified 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.SilverlightCore.PointShape –> | A screen point in pixels. |
Parameters
| Name | Type | Description |
|---|---|---|
| worldCoordinate | Point<!– System.Windows.Point –> | A point in world coordinates. |
<!– ThinkGeo.MapSuite.SilverlightEdition.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.
Overloads
This method returns a point shape in world coordinates from screen coordinates.
Remarks
This method converts a screen point to a point in world coordinates.
Return Value
| Return Type | Description |
|---|---|
| PointShape<!– ThinkGeo.MapSuite.SilverlightCore.PointShape –> | A point shape in world coordinates. |
Parameters
| Name | Type | Description |
|---|---|---|
| screenCoordinate | PointShape<!– ThinkGeo.MapSuite.SilverlightCore.PointShape –> | The point (in screen coordinates) to convert to world coordinates. |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
ToWorldCoordinate(Double, Double)
This method returns a point shape in world coordinates from the specified X, Y screen coordinates.
Overloads
This method returns a point shape in world coordinates from the specified 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.SilverlightCore.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.SilverlightEdition.Overlay –> Go Back
ToWorldCoordinate(Point)
This method returns a point shape in world coordinates from a ScreenPointF structure.
Overloads
This method returns a point shape in world coordinates from screen coordinates.
Remarks
This method converts a screen point to a point in world coordinates.
Return Value
| Return Type | Description |
|---|---|
| PointShape<!– ThinkGeo.MapSuite.SilverlightCore.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.SilverlightEdition.Overlay –> Go Back
Protected Methods
DrawAttributionCore(GeoCanvas)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.SilverlightCore.GeoCanvas –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
DrawCore(RectangleShape)
This method draws the features in the specified extent.
Overloads
Zooms the overlay to the extent that you specify.
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.SilverlightCore.RectangleShape –> | The new world extent of the map. |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
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
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
OnDrawingAttribution(DrawingAttributionOverlayEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.SilverlightEdition.DrawingAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
OnDrawnAttribution(DrawnAttributionOverlayEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.SilverlightEdition.DrawnAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> 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.SilverlightEdition.Overlay –> Go Back
ZoomStoryCompletedCore()
This method raised when zooming animation plays completed.
Remarks
This method raised when zooming animation plays completed.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
Public Properties
Attribution
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> 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.SilverlightEdition.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.SilverlightEdition.Overlay –> Go Back
OverlayElement
An FrameworkElement that contains the overlay.
Return Value
| Return Type |
|---|
| FrameworkElement<!– System.Windows.FrameworkElement –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.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.SilverlightEdition.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.SilverlightEdition.Overlay –> Go Back
StoryboardForPanning
Gets the Storyboard object for panning.
Return Value
| Return Type |
|---|
| Storyboard<!– System.Windows.Media.Animation.Storyboard –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
StoryboardForZooming
Gets the Storyboard object for zooming.
Return Value
| Return Type |
|---|
| Storyboard<!– System.Windows.Media.Animation.Storyboard –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> 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.SilverlightEdition.TransitionEffect –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.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.SilverlightEdition.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.SilverlightEdition.Overlay –> Go Back
ZoomFrameX
Gets the SplineDoubleKeyFrame for zooming.
Return Value
| Return Type |
|---|
| SplineDoubleKeyFrame<!– System.Windows.Media.Animation.SplineDoubleKeyFrame –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
ZoomFrameY
Gets the SplineDoubleKeyFrame for zooming.
Return Value
| Return Type |
|---|
| SplineDoubleKeyFrame<!– System.Windows.Media.Animation.SplineDoubleKeyFrame –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.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.SilverlightEdition.Map –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> 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.SilverlightEdition.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.SilverlightEdition.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.SilverlightEdition.Overlay –> Go Back
Public Events
DrawingAttribution
Event Arguments
| Event Arguments |
|---|
| DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.SilverlightEdition.DrawingAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
DrawnAttribution
Event Arguments
| Event Arguments |
|---|
| DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.SilverlightEdition.DrawnAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.SilverlightEdition.Overlay –> Go Back
NOTOC SilverlightEdition ThinkGeo.MapSuite.SilverlightEdition UpdateDocumentation
thinkgeo.mapsuite.silverlightedition.overlay.1440040135.txt.gz · Last modified: 2015/09/21 03:29 (external edit)