This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.desktopedition.layeroverlay [2015/09/22 08:11] admin |
thinkgeo.mapsuite.desktopedition.layeroverlay [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.DesktopEdition.LayerOverlay ====== | ====== ThinkGeo.MapSuite.DesktopEdition.LayerOverlay ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
: This class represents a group of layers; each layer can be of any layer type. | : This class represents a group of layers; each layer can be of any layer type. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 536: | Line 539: | ||
** {{wiki:PublicProperty.gif|}} Layers ** | ** {{wiki:PublicProperty.gif|}} Layers ** | ||
- | Gets a GeoCollection that contains the layers that will draw on the image. | + | * //Gets a GeoCollection that contains the layers that will draw on the image.// |
== Remarks == | == Remarks == | ||
- | The <strong>Layers</strong> property holds all of the layers that are used by the <strong>Draw</strong> method. The Draw method loops through all layers to filter out features and draw on the image with the specified styles. | + | * //The <strong>Layers</strong> property holds all of the layers that are used by the <strong>Draw</strong> method. The Draw method loops through all layers to filter out features and draw on the image with the specified styles.// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCollection<T>[[ThinkGeo.MapSuite.Core.Layer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection<T>]] | ||
Line 544: | Line 547: | ||
** {{wiki:PublicProperty.gif|}} IsEmpty ** | ** {{wiki:PublicProperty.gif|}} IsEmpty ** | ||
- | Overrides the property in the base class Overlay. | + | * //Overrides the property in the base class Overlay.// |
== Remarks == | == Remarks == | ||
- | If the layer count is zero, returns true. Otherwise, returns false. | + | * //If the layer count is zero, returns true. Otherwise, returns false.// |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 552: | Line 555: | ||
** {{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.LayerOverlay#DrawAttributionCore.28GeoCanvas.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#DrawAttributionCore.28GeoCanvas.29// |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 560: | Line 563: | ||
** {{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.LayerOverlay#Lock | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#Lock// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]] | * Type:[[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]] | ||
Line 568: | Line 571: | ||
** {{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.LayerOverlay#IsBase | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#IsBase// |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 576: | Line 579: | ||
** {{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.LayerOverlay#DrawingExceptionMode | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#DrawingExceptionMode// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | ||
Line 584: | Line 587: | ||
** {{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.LayerOverlay#IsVisible | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#IsVisible// |
== Return Value == | == Return Value == | ||
* Type:Boolean | * Type:Boolean | ||
Line 592: | Line 595: | ||
** {{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.LayerOverlay#Name | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#Name// |
== Return Value == | == Return Value == | ||
* Type:String | * Type:String | ||
Line 600: | Line 603: | ||
** {{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 608: | Line 611: | ||
** {{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.LayerOverlay#PreviewTileCache | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#PreviewTileCache// |
== Return Value == | == Return Value == | ||
* Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | ||
Line 616: | Line 619: | ||
** {{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 624: | Line 627: | ||
** {{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 633: | Line 636: | ||
** {{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 641: | Line 644: | ||
==== 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.LayerOverlay#OnDrawing.28DrawingOverlayEventArgs.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#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.LayerOverlay#OnDrawn.28DrawnOverlayEventArgs.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#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.LayerOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#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.LayerOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29 | + | * //For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.LayerOverlay#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]] | ||