This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.wpfdesktopedition.popupoverlay [2015/09/18 03:15] admin |
thinkgeo.mapsuite.wpfdesktopedition.popupoverlay [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay ====== | ====== ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This class represents an overlay to place popups on the map. | This class represents an overlay to place popups on the map. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 9: | Line 12: | ||
** {{wiki:PublicMethod.gif|}} PopupOverlay() ** | ** {{wiki:PublicMethod.gif|}} PopupOverlay() ** | ||
- | This is constructor of PopupOverlay class. | + | * //This is constructor of PopupOverlay class.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#PopupOverlay.28.29// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} PopupOverlay(IEnumerable<Popup>) ** | ** {{wiki:PublicMethod.gif|}} PopupOverlay(IEnumerable<Popup>) ** | ||
- | This is constructor of PopupOverlay class. | + | * //This is constructor of PopupOverlay class.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:// |
== Parameters == | == Parameters == | ||
* //popups// | * //popups// | ||
Line 29: | Line 32: | ||
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>) ** | ** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:// |
== Return Value == | == Return Value == | ||
Line 45: | Line 48: | ||
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan) ** | ** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Refresh.28TimeSpan.29// |
== Return Value == | == Return Value == | ||
Line 61: | Line 64: | ||
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan,RequestDrawingBufferTimeType) ** | ** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan,RequestDrawingBufferTimeType) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:// |
== Return Value == | == Return Value == | ||
Line 81: | Line 84: | ||
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan) ** | ** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Refresh.28RectangleShape.2C_TimeSpan.29// |
== Return Value == | == Return Value == | ||
Line 101: | Line 104: | ||
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** | ** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:// |
== Return Value == | == Return Value == | ||
Line 125: | Line 128: | ||
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>,TimeSpan) ** | ** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>,TimeSpan) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:// |
== Return Value == | == Return Value == | ||
Line 145: | Line 148: | ||
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) ** | ** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:// |
== Return Value == | == Return Value == | ||
Line 169: | Line 172: | ||
** {{wiki:PublicMethod.gif|}} Initialize(MapArguments) ** | ** {{wiki:PublicMethod.gif|}} Initialize(MapArguments) ** | ||
- | N/A | + | * //This method initializes overlay object.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //This is a wrapper method for the virtual method InitializeCore.// |
== Return Value == | == Return Value == | ||
Line 180: | Line 183: | ||
* //mapArguments// | * //mapArguments// | ||
* Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]] | * Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]] | ||
- | * Description:N/A | + | * Description:This parameter maintains current map information for calculating mechanism. |
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Refresh.28RectangleShape.29// |
== Return Value == | == Return Value == | ||
Line 201: | Line 204: | ||
** {{wiki:PublicMethod.gif|}} Refresh() ** | ** {{wiki:PublicMethod.gif|}} Refresh() ** | ||
- | N/A | + | * //This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.// |
== Return Value == | == Return Value == | ||
Line 213: | Line 216: | ||
** {{wiki:PublicMethod.gif|}} Close() ** | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Close.28.29// |
== Return Value == | == Return Value == | ||
Line 225: | Line 228: | ||
** {{wiki:PublicMethod.gif|}} Open() ** | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Open.28.29// |
== Return Value == | == Return Value == | ||
Line 237: | Line 240: | ||
** {{wiki:PublicMethod.gif|}} Draw(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} Draw(RectangleShape) ** | ||
- | N/A | + | * //This method draws the overlay with the provided extent in world coordinate.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Draw.28RectangleShape.29// |
== Return Value == | == Return Value == | ||
Line 248: | Line 251: | ||
* //targetExtent// | * //targetExtent// | ||
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:N/A | + | * Description:This parameter indicates an extent in world coordinate for drawing the overlay. |
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} Draw(RectangleShape,OverlayRefreshType) ** | ** {{wiki:PublicMethod.gif|}} Draw(RectangleShape,OverlayRefreshType) ** | ||
- | N/A | + | * //This method draws the overlay with the provided extent in world coordinate.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Draw.28RectangleShape.2C_OverlayRefreshType.29// |
== Return Value == | == Return Value == | ||
Line 264: | Line 267: | ||
* //targetExtent// | * //targetExtent// | ||
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:N/A | + | * Description:This parameter indicates an extent in world coordinate for drawing the overlay. |
* //refreshType// | * //refreshType// | ||
* Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType|OverlayRefreshType]] | * Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType|OverlayRefreshType]] | ||
- | * Description:N/A | + | * Description:This parameter indicates whether the elements of this overlay needs to be refreshed. For example, TileOverlay is formed by tiles. When panning the map around, the existing tile doesn't need to be redraw, the only thing we need to do is modifying the position of these tiles. On another hand, when click to change the style of the overlay, we need to redraw the tile images to change the appearance. So we need refresh mode. |
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} PanTo(RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} PanTo(RectangleShape) ** | ||
- | N/A | + | * //This method pans the overlay to the provided world extent.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.// |
== Return Value == | == Return Value == | ||
Line 284: | Line 287: | ||
* //targetExtent// | * //targetExtent// | ||
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:N/A | + | * Description:This parameter is the target world extent for panning. |
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
- | N/A | + | * //This method gets a bounding box of the Overlay.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the Overlay. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:N/A | + | * Description:A RectangleShape indicating the bounding box of this overlay |
== Parameters == | == Parameters == | ||
Line 301: | Line 304: | ||
** {{wiki:PublicMethod.gif|}} SaveState() ** | ** {{wiki:PublicMethod.gif|}} SaveState() ** | ||
- | N/A | + | * //This method saves overlay state to a byte array.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#SaveState.28.29// |
== Return Value == | == Return Value == | ||
* Type:Byte[] | * Type:Byte[] | ||
- | * Description:N/A | + | * Description:A byte array indicates current overlay state. |
== Parameters == | == Parameters == | ||
Line 313: | Line 316: | ||
** {{wiki:PublicMethod.gif|}} LoadState(Byte[]) ** | ** {{wiki:PublicMethod.gif|}} LoadState(Byte[]) ** | ||
- | N/A | + | * //This method restore the overlay state back from the specified state.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:// |
== Return Value == | == Return Value == | ||
Line 324: | Line 327: | ||
* //state// | * //state// | ||
* Type:Byte[] | * Type:Byte[] | ||
- | * Description:N/A | + | * Description:This parameter indicates the state for restore the overlay. |
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} Dispose() ** | ** {{wiki:PublicMethod.gif|}} Dispose() ** | ||
- | N/A | + | * //This method dispose unmanaged resource used in this class.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Dispose.28.29// |
== Return Value == | == Return Value == | ||
Line 341: | Line 344: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#ToString.28.29// |
== Return Value == | == Return Value == | ||
Line 353: | Line 356: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Equals.28Object.29// |
== Return Value == | == Return Value == | ||
Line 369: | Line 372: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#GetHashCode.28.29// |
== Return Value == | == Return Value == | ||
Line 381: | Line 384: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#GetType.28.29// |
== Return Value == | == Return Value == | ||
Line 394: | Line 397: | ||
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
- | This method returns a bounding box to hold all popups. | + | * //This method returns a bounding box to hold all popups.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#GetBoundingBoxCore.28.29// |
== Return Value == | == Return Value == | ||
Line 406: | Line 409: | ||
** {{wiki:ProtectedMethod.gif|}} DrawCore(RectangleShape,OverlayRefreshType) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(RectangleShape,OverlayRefreshType) ** | ||
- | This method draws the popups by the specified targetExtent. | + | * //This method draws the popups by the specified targetExtent.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#DrawCore.28RectangleShape.2C_OverlayRefreshType.29// |
== Return Value == | == Return Value == | ||
Line 426: | Line 429: | ||
** {{wiki:ProtectedMethod.gif|}} InitializeCore(MapArguments) ** | ** {{wiki:ProtectedMethod.gif|}} InitializeCore(MapArguments) ** | ||
- | N/A | + | * //This method initializes overlay object.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //When implementing this method, consider initializing the overlay canvas such as setting its z-index, setting current map reference to the CurrentMap property.// |
== Return Value == | == Return Value == | ||
Line 437: | Line 440: | ||
* //mapArguments// | * //mapArguments// | ||
* Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]] | * Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]] | ||
- | * Description:N/A | + | * Description:This parameter maintains current map information for calculating mechanism. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} RefreshCore(RectangleShape) ** | ** {{wiki:ProtectedMethod.gif|}} RefreshCore(RectangleShape) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#RefreshCore.28RectangleShape.29// |
== Return Value == | == Return Value == | ||
Line 458: | Line 461: | ||
** {{wiki:ProtectedMethod.gif|}} RefreshCore() ** | ** {{wiki:ProtectedMethod.gif|}} RefreshCore() ** | ||
- | N/A | + | * //This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.// |
== Return Value == | == Return Value == | ||
Line 470: | Line 473: | ||
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#CloseCore.28.29// |
== Return Value == | == Return Value == | ||
Line 482: | Line 485: | ||
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OpenCore.28.29// |
== Return Value == | == Return Value == | ||
Line 494: | Line 497: | ||
** {{wiki:ProtectedMethod.gif|}} 4hM=(GeoCanvas) ** | ** {{wiki:ProtectedMethod.gif|}} 4hM=(GeoCanvas) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 510: | Line 513: | ||
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) ** | ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#DrawAttributionCore.28GeoCanvas.29// |
== Return Value == | == Return Value == | ||
Line 526: | Line 529: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29// |
== Return Value == | == Return Value == | ||
Line 542: | Line 545: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29// |
== Return Value == | == Return Value == | ||
Line 558: | Line 561: | ||
** {{wiki:ProtectedMethod.gif|}} PanToCore(RectangleShape) ** | ** {{wiki:ProtectedMethod.gif|}} PanToCore(RectangleShape) ** | ||
- | N/A | + | * //This method pans the overlay to the provided world extent.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.// |
== Return Value == | == Return Value == | ||
Line 569: | Line 572: | ||
* //targetExtent// | * //targetExtent// | ||
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
- | * Description:N/A | + | * Description:This parameter is the target world extent for panning. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) ** | ||
- | N/A | + | * //This method raises before the overlay is drawing.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawing.28DrawingOverlayEventArgs.29// |
== Return Value == | == Return Value == | ||
Line 585: | Line 588: | ||
* //e// | * //e// | ||
* Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] | * Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] | ||
- | * Description:N/A | + | * Description:This parameter is the event argument for Drawing event. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) ** | ||
- | N/A | + | * //This method raises after the overlay is drawn.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawn.28DrawnOverlayEventArgs.29// |
== Return Value == | == Return Value == | ||
Line 601: | Line 604: | ||
* //e// | * //e// | ||
* Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] | * Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] | ||
- | * Description:N/A | + | * Description:This parameter is the event argument for Drawn event. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} SaveStateCore() ** | ** {{wiki:ProtectedMethod.gif|}} SaveStateCore() ** | ||
- | N/A | + | * //This method saves overlay state to a byte array.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#SaveStateCore.28.29// |
== Return Value == | == Return Value == | ||
* Type:Byte[] | * Type:Byte[] | ||
- | * Description:N/A | + | * Description:A byte array indicates current overlay state. |
== Parameters == | == Parameters == | ||
Line 618: | Line 621: | ||
** {{wiki:ProtectedMethod.gif|}} LoadStateCore(Byte[]) ** | ** {{wiki:ProtectedMethod.gif|}} LoadStateCore(Byte[]) ** | ||
- | N/A | + | * //This method restore the overlay state back from the specified state.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:// |
== Return Value == | == Return Value == | ||
Line 629: | Line 632: | ||
* //state// | * //state// | ||
* Type:Byte[] | * Type:Byte[] | ||
- | * Description:N/A | + | * Description:This parameter indicates the state for restore the overlay. |
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Finalize.28.29// |
== Return Value == | == Return Value == | ||
Line 646: | Line 649: | ||
** {{wiki:ProtectedMethod.gif|}} Dispose(Boolean) ** | ** {{wiki:ProtectedMethod.gif|}} Dispose(Boolean) ** | ||
- | N/A | + | * //This method dispose unmanaged resource used in this class.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Dispose.28Boolean.29// |
== Return Value == | == Return Value == | ||
Line 662: | Line 665: | ||
** {{wiki:ProtectedMethod.gif|}} OnRefreshing(OverlayRefreshType) ** | ** {{wiki:ProtectedMethod.gif|}} OnRefreshing(OverlayRefreshType) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 678: | Line 681: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#MemberwiseClone.28.29// |
== Return Value == | == Return Value == | ||
Line 693: | Line 696: | ||
This property gets a collection of popup that are added into this overlay. | This property gets a collection of popup that are added into this overlay. | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Popups |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.WpfDesktopEdition.Popup, WpfDesktopEdition, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.WpfDesktopEdition.Popup, WpfDesktopEdition, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | ||
Line 701: | Line 704: | ||
N/A | N/A | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#AutoRefreshInterval |
== Return Value == | == Return Value == | ||
* Type:TimeSpan | * Type:TimeSpan | ||
Line 707: | Line 710: | ||
** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
- | N/A | + | Gets or sets the name of this overaly. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Name |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 715: | Line 718: | ||
** {{wiki:PublicProperty.gif|}} MapArguments ** | ** {{wiki:PublicProperty.gif|}} MapArguments ** | ||
- | N/A | + | Gets or sets current map information which will be used for calculating mechanism. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#Initialize.28MapArguments.29 |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]] | * Type:[[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]] | ||
Line 723: | Line 726: | ||
** {{wiki:PublicProperty.gif|}} OverlayCanvas ** | ** {{wiki:PublicProperty.gif|}} OverlayCanvas ** | ||
- | N/A | + | Gets or sets the actual canvas which maintains all the visual elements on the overlay. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OverlayCanvas |
== Return Value == | == Return Value == | ||
* Type:Canvas | * Type:Canvas | ||
Line 733: | Line 736: | ||
N/A | N/A | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#IsBase |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 741: | Line 744: | ||
N/A | N/A | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#CanRefreshRegion |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 747: | Line 750: | ||
** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | ||
- | N/A | + | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#DrawingExceptionMode |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | ||
Line 755: | Line 758: | ||
** {{wiki:PublicProperty.gif|}} IsVisible ** | ** {{wiki:PublicProperty.gif|}} IsVisible ** | ||
- | N/A | + | Gets or sets if this overlay is visible. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#IsVisible |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 765: | Line 768: | ||
N/A | N/A | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#DrawAttributionCore.28GeoCanvas.29 |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 771: | Line 774: | ||
** {{wiki:PublicProperty.gif|}} IsEmpty ** | ** {{wiki:PublicProperty.gif|}} IsEmpty ** | ||
- | N/A | + | This property gets if this overlay is empty or not. |
== Remarks == | == Remarks == | ||
- | N/A | + | This property enhances the performance of the overlay while drawing. If is true, we will skip drawing this overlay and continue drawing the next overlay. |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 780: | Line 783: | ||
** {{wiki:ProtectedProperty.gif|}} PreviousExtent ** | ** {{wiki:ProtectedProperty.gif|}} PreviousExtent ** | ||
- | N/A | + | Gets or sets the previous exent of the overlay. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#PreviousExtent |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
Line 796: | Line 799: | ||
** {{wiki:ProtectedProperty.gif|}} IsOverlayInitialized ** | ** {{wiki:ProtectedProperty.gif|}} IsOverlayInitialized ** | ||
- | N/A | + | Gets or sets if the overlay canvas is initialized. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#IsOverlayInitialized |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 804: | Line 807: | ||
==== Public Events ==== | ==== Public Events ==== | ||
** {{wiki:PublicEvent.gif|}} Drawing ** | ** {{wiki:PublicEvent.gif|}} Drawing ** | ||
- | N/A | + | This event raises before the overlay is drawing. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawing.28DrawingOverlayEventArgs.29 |
Event Arguments:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] | ||
** {{wiki:PublicEvent.gif|}} Drawn ** | ** {{wiki:PublicEvent.gif|}} Drawn ** | ||
- | N/A | + | This event raises after the overlay is drawn. |
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawn.28DrawnOverlayEventArgs.29 |
Event Arguments:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] | ||
Line 820: | Line 823: | ||
N/A | N/A | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29 |
Event Arguments:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] | ||
Line 827: | Line 830: | ||
N/A | N/A | ||
== Remarks == | == Remarks == | ||
- | N/A | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.PopupOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29 |
Event Arguments:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] | ||