thinkgeo.mapsuite.desktopedition.overlay
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.desktopedition.overlay [2015/09/22 08:12] admin |
thinkgeo.mapsuite.desktopedition.overlay [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.DesktopEdition.Overlay ====== | ====== ThinkGeo.MapSuite.DesktopEdition.Overlay ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| Serves as the base class that defines the properties and methods shared by all types of overlays. | Serves as the base class that defines the properties and methods shared by all types of overlays. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 546: | Line 549: | ||
| ** {{wiki:PublicProperty.gif|}} Attribution ** | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawAttributionCore.28GeoCanvas.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawAttributionCore.28GeoCanvas.29// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 554: | Line 557: | ||
| ** {{wiki:PublicProperty.gif|}} Lock ** | ** {{wiki:PublicProperty.gif|}} Lock ** | ||
| - | This property gets the OverlayLock object. | + | * //This property gets the OverlayLock object.// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Lock | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Lock// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]] | * Type:[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]] | ||
| Line 562: | Line 565: | ||
| ** {{wiki:PublicProperty.gif|}} IsBase ** | ** {{wiki:PublicProperty.gif|}} IsBase ** | ||
| - | Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false. | + | * //Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsBase | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsBase// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 570: | Line 573: | ||
| ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | ||
| - | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. | + | * //This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawingExceptionMode | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawingExceptionMode// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | ||
| Line 578: | Line 581: | ||
| ** {{wiki:PublicProperty.gif|}} IsVisible ** | ** {{wiki:PublicProperty.gif|}} IsVisible ** | ||
| - | Gets or sets a value that indicates whether the overlay is visible on the map. | + | * //Gets or sets a value that indicates whether the overlay is visible on the map.// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsVisible | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsVisible// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 586: | Line 589: | ||
| ** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | Gets or sets the name of the overlay, which can be used to represent a specific overlay. | + | * //Gets or sets the name of the overlay, which can be used to represent a specific overlay.// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Name | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Name// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 594: | Line 597: | ||
| ** {{wiki:PublicProperty.gif|}} TileCache ** | ** {{wiki:PublicProperty.gif|}} TileCache ** | ||
| - | This property gets or sets the TileCache used for the overlay. | + | * //This property gets or sets the TileCache used for the overlay.// |
| == Remarks == | == Remarks == | ||
| - | The TileCache system is always used for better performance, especially in the case where your application tiles can be pregenerated. | + | * //The TileCache system is always used for better performance, especially in the case where your application tiles can be pregenerated.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | ||
| Line 602: | Line 605: | ||
| ** {{wiki:PublicProperty.gif|}} PreviewTileCache ** | ** {{wiki:PublicProperty.gif|}} PreviewTileCache ** | ||
| - | This property gets or sets the preview tile cache system. In order for this system to work, you must be in multi-threaded mode and have the tile cache set. | + | * //This property gets or sets the preview tile cache system. In order for this system to work, you must be in multi-threaded mode and have the tile cache set.// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#PreviewTileCache | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#PreviewTileCache// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | ||
| Line 610: | Line 613: | ||
| ** {{wiki:PublicProperty.gif|}} IsEmpty ** | ** {{wiki:PublicProperty.gif|}} IsEmpty ** | ||
| - | This property can be overridden by its base class. If it is not overridden, its default return value will be false. If this property is empty, we can skip drawing to achieve better performance. | + | * //This property can be overridden by its base class. If it is not overridden, its default return value will be false. If this property is empty, we can skip drawing to achieve better performance.// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsEmpty | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsEmpty// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 618: | Line 621: | ||
| ** {{wiki:PublicProperty.gif|}} DrawingTime ** | ** {{wiki:PublicProperty.gif|}} DrawingTime ** | ||
| - | This property gets the last drawing time for the Overlay. | + | * //This property gets the last drawing time for the Overlay.// |
| == Remarks == | == Remarks == | ||
| - | We track the drawing time for the Overlay and report it back in this method. This is useful to determine the speed of various Overlays. | + | * //We track the drawing time for the Overlay and report it back in this method. This is useful to determine the speed of various Overlays.// |
| == Return Value == | == Return Value == | ||
| * Type:TimeSpan | * Type:TimeSpan | ||
| Line 626: | Line 629: | ||
| ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here: | + | * //For the most updated Info for this topic, please check it here:// |
| == Return Value == | == Return Value == | ||
| * Type:TimeSpan | * Type:TimeSpan | ||
| Line 635: | Line 638: | ||
| ** {{wiki:ProtectedProperty.gif|}} rxM= ** | ** {{wiki:ProtectedProperty.gif|}} rxM= ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | * Type:[[ThinkGeo.MapSuite.Core.BitmapTile|BitmapTile]] | ||
| Line 643: | Line 646: | ||
| ==== Public Events ==== | ==== Public Events ==== | ||
| ** {{wiki:PublicEvent.gif|}} Drawing ** | ** {{wiki:PublicEvent.gif|}} Drawing ** | ||
| - | This event will be fired before the Overlay is drawn. | + | * //This event will be fired before the Overlay is drawn.// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawing.28DrawingOverlayEventArgs.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawing.28DrawingOverlayEventArgs.29// |
| Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] | ||
| ** {{wiki:PublicEvent.gif|}} Drawn ** | ** {{wiki:PublicEvent.gif|}} Drawn ** | ||
| - | This event will be fired after the Overlay is drawn. | + | * //This event will be fired after the Overlay is drawn.// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawn.28DrawnOverlayEventArgs.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawn.28DrawnOverlayEventArgs.29// |
| Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] | ||
| ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29// |
| Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] | ||
| ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29// |
| Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] | ||
| ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here: | + | * //For the most updated Info for this topic, please check it here:// |
| Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] | ||
| ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | For the most updated Info for this topic, please check it here: | + | * //For the most updated Info for this topic, please check it here:// |
| Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] | ||
thinkgeo.mapsuite.desktopedition.overlay.1442909548.txt.gz · Last modified: 2015/09/22 08:12 by admin