This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.googlemapslayer [2015/09/21 01:04] admin |
thinkgeo.mapsuite.core.googlemapslayer [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.GoogleMapsLayer ====== | ====== ThinkGeo.MapSuite.Core.GoogleMapsLayer ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
Represents an object that encapsulates a Google Map layer. | Represents an object that encapsulates a Google Map layer. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 9: | Line 12: | ||
** {{wiki:PublicMethod.gif|}} GoogleMapsLayer() ** | ** {{wiki:PublicMethod.gif|}} GoogleMapsLayer() ** | ||
- | This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually. | + | * //This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} GoogleMapsLayer(String,String,String) ** | ** {{wiki:PublicMethod.gif|}} GoogleMapsLayer(String,String,String) ** | ||
- | This is the constructor the for the class. | + | * //This is the constructor the for the class.// |
== Remarks == | == Remarks == | ||
- | This constructor initializes a new layer and assgin a license key. | + | * //This constructor initializes a new layer and assgin a license key.// |
== Parameters == | == Parameters == | ||
* //cacheDirectory// | * //cacheDirectory// | ||
Line 33: | Line 36: | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} GoogleMapsLayer(String,String,String,GeoWebProxy) ** | + | ** {{wiki:PublicMethod.gif|}} GoogleMapsLayer(String,String,String,WebProxy) ** |
- | This is the constructor the for the class. | + | * //This is the constructor the for the class.// |
== Remarks == | == Remarks == | ||
- | This constructor initializes a new layer and assgin a license key and initilize a cache directory. | + | * //This constructor initializes a new layer and assgin a license key and initilize a cache directory.// |
== Parameters == | == Parameters == | ||
* //cacheDirectory// | * //cacheDirectory// | ||
Line 52: | Line 55: | ||
* //webProxy// | * //webProxy// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeoWebProxy|GeoWebProxy]] | + | * Type:WebProxy |
* Description:N/A | * Description:N/A | ||
Line 58: | Line 61: | ||
==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
==== Public Methods ==== | ==== Public Methods ==== | ||
- | ** {{wiki:PublicMethod.gif|}} ClearCache() ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Void | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
- | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} ClearCache(String,TimeSpan,Double) ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Void | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
- | * //cacheFolder// | ||
- | * Type:String | ||
- | * Description:N/A | ||
- | |||
- | * //tileExpiration// | ||
- | * Type:TimeSpan | ||
- | * Description:N/A | ||
- | |||
- | * //maxSizeInMegabytes// | ||
- | * Type:Double | ||
- | * Description:N/A | ||
- | |||
- | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} GetGoogleMapsImage(Double,Double,Int32,Double,Double) ** | ** {{wiki:PublicMethod.gif|}} GetGoogleMapsImage(Double,Double,Int32,Double,Double) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Bitmap |
* Description:N/A | * Description:N/A | ||
Line 128: | Line 95: | ||
** {{wiki:PublicMethod.gif|}} GetPictureFormat() ** | ** {{wiki:PublicMethod.gif|}} GetPictureFormat() ** | ||
- | Get picture format string which will use for request url. | + | * //Get picture format string which will use for request url.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 138: | Line 105: | ||
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] | + | * Type:Void |
* Description:N/A | * Description:N/A | ||
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] | + | * Type:Void |
* Description:N/A | * Description:N/A | ||
== Parameters == | == Parameters == | ||
+ | * //extentToRefresh// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} Open() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 173: | Line 144: | ||
== Parameters == | == Parameters == | ||
+ | * //extentsToRefresh// | ||
+ | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} Close() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 185: | Line 160: | ||
== Parameters == | == Parameters == | ||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Void |
* Description:N/A | * Description:N/A | ||
== Parameters == | == Parameters == | ||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTimeType// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 209: | Line 196: | ||
== Parameters == | == Parameters == | ||
- | * //canvas// | + | * //extentToRefresh// |
- | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
* Description:N/A | * Description:N/A | ||
- | * //labelsInAllLayers// | + | * //bufferTime// |
- | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | * Type:TimeSpan |
* Description:N/A | * Description:N/A | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 229: | Line 216: | ||
== Parameters == | == Parameters == | ||
+ | * //extentToRefresh// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTimeType// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | ||
+ | * Description:N/A | ||
+ | |||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 241: | Line 240: | ||
== Parameters == | == Parameters == | ||
- | * //extentToRefresh// | + | * //extentsToRefresh// |
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> |
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
* Description:N/A | * Description:N/A | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** | + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 259: | Line 262: | ||
* //extentsToRefresh// | * //extentsToRefresh// | ||
* Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTime// | ||
+ | * Type:TimeSpan | ||
+ | * Description:N/A | ||
+ | |||
+ | * //bufferTimeType// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | ||
* Description:N/A | * Description:N/A | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** | + | ** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] |
* Description:N/A | * Description:N/A | ||
== Parameters == | == Parameters == | ||
- | * //bufferTime// | + | <div newline></div> |
- | * Type:TimeSpan | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
- | * Description:N/A | + | |
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** | + | ** {{wiki:PublicMethod.gif|}} Open() ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 289: | Line 308: | ||
== Parameters == | == Parameters == | ||
- | * //extentToRefresh// | + | <div newline></div> |
- | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | ** {{wiki:PublicMethod.gif|}} Close() ** |
- | * Description:N/A | + | |
- | * //bufferTime// | + | * //N/A// |
- | * Type:TimeSpan | + | == Remarks == |
- | * Description:N/A | + | * //N/A// |
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
- | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** | + | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** |
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
+ | |||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
== Return Value == | == Return Value == | ||
Line 309: | Line 344: | ||
== Parameters == | == Parameters == | ||
- | * //extentsToRefresh// | + | * //canvas// |
- | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
* Description:N/A | * Description:N/A | ||
- | * //bufferTime// | + | * //labelsInAllLayers// |
- | * Type:TimeSpan | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
* Description:N/A | * Description:N/A | ||
Line 320: | Line 355: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 332: | Line 367: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 348: | Line 383: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 360: | Line 395: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 373: | Line 408: | ||
** {{wiki:ProtectedMethod.gif|}} SendWebRequest(WebRequest) ** | ** {{wiki:ProtectedMethod.gif|}} SendWebRequest(WebRequest) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 389: | Line 424: | ||
** {{wiki:ProtectedMethod.gif|}} SendWebRequestCore(WebRequest) ** | ** {{wiki:ProtectedMethod.gif|}} SendWebRequestCore(WebRequest) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 405: | Line 440: | ||
** {{wiki:ProtectedMethod.gif|}} GetGoogleMapsImageCore(Double,Double,Int32,Double,Double) ** | ** {{wiki:ProtectedMethod.gif|}} GetGoogleMapsImageCore(Double,Double,Int32,Double,Double) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Bitmap |
* Description:N/A | * Description:N/A | ||
Line 437: | Line 472: | ||
** {{wiki:ProtectedMethod.gif|}} OnCreatingRequest(CreatingRequestGoogleMapsLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnCreatingRequest(CreatingRequestGoogleMapsLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 453: | Line 488: | ||
** {{wiki:ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 469: | Line 504: | ||
** {{wiki:ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 485: | Line 520: | ||
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
- | This method opens the Layer so that it is initialized and ready to use. | + | * //This method opens the Layer so that it is initialized and ready to use.// |
== Remarks == | == Remarks == | ||
- | This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer. | + | * //This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.// |
== Return Value == | == Return Value == | ||
Line 497: | Line 532: | ||
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
- | This method closes the Layer and releases any resources it was using. | + | * //This method closes the Layer and releases any resources it was using.// |
== Remarks == | == Remarks == | ||
- | This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future. | + | * //This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.// |
== Return Value == | == Return Value == | ||
Line 509: | Line 544: | ||
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | ||
- | This method draws the Layer. | + | * //This method draws the Layer.// |
== Remarks == | == Remarks == | ||
- | This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided. When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection. | + | * //This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided. When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.// |
== Return Value == | == Return Value == | ||
Line 525: | Line 560: | ||
* Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | ||
* Description:This parameter represents the labels used for collision detection and duplication checking. | * Description:This parameter represents the labels used for collision detection and duplication checking. | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //eventArgs// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //eventArgs// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | ||
+ | * Description:N/A | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 541: | Line 608: | ||
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 553: | Line 620: | ||
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 565: | Line 632: | ||
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 585: | Line 652: | ||
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** | ** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 605: | Line 672: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 621: | Line 688: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 637: | Line 704: | ||
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** | ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 657: | Line 724: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 673: | Line 740: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 689: | Line 756: | ||
** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 700: | Line 767: | ||
* //e// | * //e// | ||
* Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | ||
- | * Description:N/A | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Void | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
- | * //eventArgs// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | ||
- | * Description:N/A | ||
- | |||
- | <div newline></div> | ||
- | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** | ||
- | |||
- | N/A | ||
- | == Remarks == | ||
- | N/A | ||
- | |||
- | == Return Value == | ||
- | * Type:Void | ||
- | * Description:N/A | ||
- | |||
- | == Parameters == | ||
- | * //eventArgs// | ||
- | * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | ||
* Description:N/A | * Description:N/A | ||
Line 737: | Line 772: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 749: | Line 784: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 819: | Line 854: | ||
Gets or sets a value that is unique to your client ID, please keep your key secure. | Gets or sets a value that is unique to your client ID, please keep your key secure. | ||
- | == Remarks == | ||
- | N/A | ||
- | == Return Value == | ||
- | * Type:String | ||
- | |||
- | ** {{wiki:PublicProperty.gif|}} CacheDirectory ** | ||
- | |||
- | Gets or sets a value represents the directory for image cache. | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
Line 878: | Line 905: | ||
If you set the image's size is different from 512*512, it will be compressed or stretched to 512*512. | If you set the image's size is different from 512*512, it will be compressed or stretched to 512*512. | ||
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * Type:Bitmap |
** {{wiki:PublicProperty.gif|}} WebProxy ** | ** {{wiki:PublicProperty.gif|}} WebProxy ** | ||
Line 886: | Line 913: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.GeoWebProxy|GeoWebProxy]] | + | * Type:WebProxy |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:TimeSpan | ||
** {{wiki:PublicProperty.gif|}} IsOpen ** | ** {{wiki:PublicProperty.gif|}} IsOpen ** | ||
Line 913: | Line 948: | ||
** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
N/A | N/A | ||
Line 936: | Line 979: | ||
* Type:Single | * Type:Single | ||
- | ** {{wiki:PublicProperty.gif|}} IsNegative ** | + | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** |
N/A | N/A | ||
Line 942: | Line 985: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:Boolean | + | * Type:Single |
- | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** | + | ** {{wiki:PublicProperty.gif|}} RedTranslation ** |
N/A | N/A | ||
Line 950: | Line 993: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:Boolean | + | * Type:Single |
- | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | + | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** |
N/A | N/A | ||
Line 958: | Line 1001: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | + | * Type:Single |
- | ** {{wiki:PublicProperty.gif|}} Attribution ** | + | ** {{wiki:PublicProperty.gif|}} KeyColors ** |
N/A | N/A | ||
Line 966: | Line 1009: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:String | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> |
- | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** | + | ** {{wiki:PublicProperty.gif|}} IsNegative ** |
N/A | N/A | ||
Line 974: | Line 1017: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:TimeSpan | + | * Type:Boolean |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | ||
+ | |||
+ | N/A | ||
+ | == Remarks == | ||
+ | N/A | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | ||
==== Protected Properties ==== | ==== Protected Properties ==== | ||
Line 983: | Line 1042: | ||
N/A | N/A | ||
== Return Value == | == Return Value == | ||
- | * Type:Dictionary<Int32,[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]> | + | * Type:Dictionary<Int32,Bitmap> |
** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** | ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** | ||
Line 1015: | Line 1074: | ||
Event Arguments:[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] | ||
- | ** {{wiki:PublicEvent.gif|}} DrawingException ** | + | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** | + | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} DrawnException ** | + | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** | + | ** {{wiki:PublicEvent.gif|}} DrawingException ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** | + | ** {{wiki:PublicEvent.gif|}} DrawnException ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** | + | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] |
- | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** | + | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** |
N/A | N/A | ||
== Remarks == | == Remarks == | ||
N/A | N/A | ||
- | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] |