thinkgeo.mapsuite.core.googlemapslayer
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.googlemapslayer [2015/08/20 03:08] 127.0.0.1 external edit |
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}} | ||
| - | |||
| - | <!-- Class --> | ||
| Represents an object that encapsulates a Google Map layer. | Represents an object that encapsulates a Google Map layer. | ||
| - | === Remarks === | ||
| - | This clss uses Google Static Maps API to implement url request. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.Core.Layer]] | + | *ThinkGeo.MapSuite.Core.Layer |
| - | ***[[ThinkGeo.MapSuite.Core.GoogleMapsLayer]] | + | ***ThinkGeo.MapSuite.Core.GoogleMapsLayer** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GoogleMapsLayer() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GoogleMapsLayer()|GoogleMapsLayer]] | | | This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GoogleMapsLayer(String, String, String)|GoogleMapsLayer]] | String, String, String | | This is the constructor the for the class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GoogleMapsLayer(String, String, String, WebProxy)|GoogleMapsLayer]] | String, String, String, WebProxy | | This is the constructor the for the class. | | + | |
| - | ==== Protected Constructors ==== | + | * //This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //None// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GoogleMapsLayer(String,String,String) ** | ||
| + | * //This is the constructor the for the class.// | ||
| + | == Remarks == | ||
| + | * //This constructor initializes a new layer and assgin a license key.// | ||
| + | == Parameters == | ||
| + | * //cacheDirectory// | ||
| + | * Type:String | ||
| + | * Description:The cache directory for the GoogleMapLayer. | ||
| + | |||
| + | * //clientId// | ||
| + | * Type:String | ||
| + | * Description:The clientId for the GoogleMapLayer. | ||
| + | |||
| + | * //privateKey// | ||
| + | * Type:String | ||
| + | * Description:The privateKey for the GoogleMapLayer. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GoogleMapsLayer(String,String,String,WebProxy) ** | ||
| + | |||
| + | * //This is the constructor the for the class.// | ||
| + | == Remarks == | ||
| + | * //This constructor initializes a new layer and assgin a license key and initilize a cache directory.// | ||
| + | == Parameters == | ||
| + | * //cacheDirectory// | ||
| + | * Type:String | ||
| + | * Description:cache directory which stored the cache image. | ||
| + | |||
| + | * //clientId// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //privateKey// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //webProxy// | ||
| + | * Type:WebProxy | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetGoogleMapsImage(Double,Double,Int32,Double,Double) ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | Create a copy of Layer using the deep clone process. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This method closes the Layer and releases any resources it was using. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas, Collection<SimpleCandidate>)|Draw]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This method draws the Layer. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This method returns the bounding box of the Layer. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetGoogleMapsImage(Double, Double, Int32, Double, Double)|GetGoogleMapsImage]] | Double, Double, Int32, Double, Double | | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetPictureFormat()|GetPictureFormat]] | | | Get picture format string which will use for request url. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadLayer(Uri)|LoadLayer]] | Uri | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadLayer(Stream)|LoadLayer]] | Stream | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This method opens the Layer so that it is initialized and ready to use. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan)|RequestDrawing]] | TimeSpan | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] | TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing()|RequestDrawing]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape)|RequestDrawing]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan)|RequestDrawing]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Bitmap | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //longitude// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //latitude// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //zoomLevelNumber// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //tileWidth// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //tileHeight// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetPictureFormat() ** | ||
| + | |||
| + | * //Get picture format string which will use for request url.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:Get picture format string which will use for request url. | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //extentToRefresh// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //extentsToRefresh// | ||
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //bufferTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //bufferTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | * //bufferTimeType// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //extentToRefresh// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //bufferTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == 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> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //extentsToRefresh// | ||
| + | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | ||
| + | * Description:N/A | ||
| + | |||
| + | * //bufferTime// | ||
| + | * Type:TimeSpan | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //extentsToRefresh// | ||
| + | * 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 | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //canvas// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //labelsInAllLayers// | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //obj// | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Type | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| ==== Protected Methods ==== | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} SendWebRequest(WebRequest) ** |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | Create a copy of Layer using the deep clone process. The default implemenation uses serialization. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]](overriden) | This method closes the Layer and releases any resources it was using. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawAttributionCore(GeoCanvas, String)|DrawAttributionCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], String | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(GeoCanvas, Collection<SimpleCandidate>)|DrawCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.Core.Layer|Layer]](overriden) | This method draws the Layer. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawException(GeoCanvas, Exception)|DrawException]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawExceptionCore(GeoCanvas, Exception)|DrawExceptionCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This method returns the bounding box of the Layer. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetGoogleMapsImageCore(Double, Double, Int32, Double, Double)|GetGoogleMapsImageCore]] | Double, Double, Int32, Double, Double | | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnCreatingRequest(CreatingRequestGoogleMapsLayerEventArgs)|OnCreatingRequest]] | [[ThinkGeo.MapSuite.Core.CreatingRequestGoogleMapsLayerEventArgs|CreatingRequestGoogleMapsLayerEventArgs]] | | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingAttribution(DrawingAttributionLayerEventArgs)|OnDrawingAttribution]] | [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingException(DrawingExceptionLayerEventArgs)|OnDrawingException]] | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingProgressChanged(DrawingProgressChangedEventArgs)|OnDrawingProgressChanged]] | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnAttribution(DrawnAttributionLayerEventArgs)|OnDrawnAttribution]] | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnException(DrawnExceptionLayerEventArgs)|OnDrawnException]] | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestedDrawing(RequestedDrawingLayerEventArgs)|OnRequestedDrawing]] | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestingDrawing(RequestingDrawingLayerEventArgs)|OnRequestingDrawing]] | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnSendingWebRequest(SendingWebRequestEventArgs)|OnSendingWebRequest]] | [[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] | | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnSentWebRequest(SentWebRequestEventArgs)|OnSentWebRequest]] | [[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] | | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.Core.Layer|Layer]](overriden) | This method opens the Layer so that it is initialized and ready to use. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SendWebRequest(WebRequest)|SendWebRequest]] | WebRequest | | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SendWebRequestCore(WebRequest)|SendWebRequestCore]] | WebRequest | | | | + | |
| - | ==== Public Properties ==== | + | * //N/A// |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | * //N/A// |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BlueTranslation|BlueTranslation]] | Single | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the amount of blue to apply to the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ClientId|ClientId]] | String | | Gets or sets a value to access the special features of Google Maps API Premier, you must provide a client ID when accessing any of the Premier API libraries or services. When registering for Google Maps API Premier, you will receive this client ID from Google Enterprise Support. All client IDs begin with a gme- prefix. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | Gets or sets the DrawExcpetionMode when exception happens. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingTime|DrawingTime]] | TimeSpan | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets the last drawing time for the layer. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#GreenTranslation|GreenTranslation]] | Single | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the amount of green to apply to the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#HasBoundingBox|HasBoundingBox]] | Boolean | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsGrayscale|IsGrayscale]] | Boolean | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets if the image should be converted to grayscale. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsNegative|IsNegative]] | Boolean | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets whether the image should be converted to negative (inverse colors). | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsOpen|IsOpen]] | Boolean | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property returns true if the Layer is open and false if it is not. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]] | Boolean | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and set the visible state of the layer. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#KeyColors|KeyColors]] | Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#MapType|MapType]] | [[ThinkGeo.MapSuite.Core.GoogleMapsMapType|GoogleMapsMapType]] | | Gets or sets a value represents the map type of the GoogleMaps. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#MaxCacheSizeInMegabytes|MaxCacheSizeInMegabytes]] | Double | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the name for the layer. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#NoDataTileImage|NoDataTileImage]] | Bitmap | | Gets or sets a value represents the image with 512*512 when no data can access. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#PictureFormat|PictureFormat]] | [[ThinkGeo.MapSuite.Core.GoogleMapsPictureFormat|GoogleMapsPictureFormat]] | | Gets or sets a value represents the image format of the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#PrivateKey|PrivateKey]] | String | | Gets or sets a value that is unique to your client ID, please keep your key secure. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ProjectedTileCache|ProjectedTileCache]] | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ProjectionFromSphericalMercator|ProjectionFromSphericalMercator]] | [[ThinkGeo.MapSuite.Core.Projection|Projection]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RedTranslation|RedTranslation]] | Single | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the amount of red to apply to the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RequestDrawingInterval|RequestDrawingInterval]] | TimeSpan | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileCache|TileCache]] | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileExpiration|TileExpiration]] | TimeSpan | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileHeight|TileHeight]] | Int32 | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileMode|TileMode]] | [[ThinkGeo.MapSuite.Core.GoogleMapsTileMode|GoogleMapsTileMode]] | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileWidth|TileWidth]] | Int32 | | | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TimeoutInSeconds|TimeoutInSeconds]] | Int32 | | Gets or sets a value represents the request timeout from the GoogleMaps server. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Transparency|Transparency]] | Single | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property gets and sets the amount of transparency to apply to the image. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#WebProxy|WebProxy]] | WebProxy | | This property gets or sets the proxy used for requesting a Web Response. | | + | |
| - | ==== Protected Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:WebResponse |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#BufferImages|BufferImages]] | Dictionary<Int32,Bitmap> | | | | + | * Description:N/A |
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOpenCore|IsOpenCore]] | Boolean | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | This property returns true if the Layer is open and false if it is not. | | + | |
| - | ==== Public Events ==== | + | == Parameters == |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | * //webRequest// |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#CreatingRequest|CreatingRequest]] | [[ThinkGeo.MapSuite.Core.CreatingRequestGoogleMapsLayerEventArgs|CreatingRequestGoogleMapsLayerEventArgs]] | | This event is called before creating the reqeust for google maps. | | + | * Type:WebRequest |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingAttribution|DrawingAttribution]] | [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | * Description:N/A |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingException|DrawingException]] | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingProgressChanged|DrawingProgressChanged]] | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnAttribution|DrawnAttribution]] | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnException|DrawnException]] | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestedDrawing|RequestedDrawing]] | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestingDrawing|RequestingDrawing]] | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#SendingWebRequest|SendingWebRequest]] | [[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] | | | | + | |
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#SentWebRequest|SentWebRequest]] | [[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] | | | | + | |
| - | ===== Public Constructors ===== | + | <div newline></div> |
| - | ==== GoogleMapsLayer() ==== | + | ** {{wiki:ProtectedMethod.gif|}} SendWebRequestCore(WebRequest) ** |
| - | This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually. | + | |
| - | === Overloads === | + | |
| - | This is the default constructor. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | * //N/A// |
| - | ==== GoogleMapsLayer(String, String, String) ==== | + | == Remarks == |
| - | This is the constructor the for the class. | + | * //N/A// |
| - | === Remarks === | + | |
| - | This constructor initializes a new layer and assgin a license key. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | cacheDirectory | String<!-- System.String --> | The cache directory for the GoogleMapLayer. | | + | |
| - | | clientId | String<!-- System.String --> | The clientId for the GoogleMapLayer. | | + | |
| - | | privateKey | String<!-- System.String --> | The privateKey for the GoogleMapLayer. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ==== GoogleMapsLayer(String, String, String, WebProxy) ==== | + | * Type:WebResponse |
| - | This is the constructor the for the class. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This constructor initializes a new layer and assgin a license key and initilize a cache directory. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | cacheDirectory | String<!-- System.String --> | cache directory which stored the cache image. | | + | |
| - | | clientId | String<!-- System.String --> | | | + | |
| - | | privateKey | String<!-- System.String --> | | | + | |
| - | | webProxy | WebProxy<!-- System.Net.WebProxy --> | | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ===== Protected Constructors ===== | + | * //webRequest// |
| - | ===== Public Methods ===== | + | * Type:WebRequest |
| - | ==== CloneDeep() ==== | + | * Description:N/A |
| - | Create a copy of Layer using the deep clone process. | + | |
| - | === Remarks === | + | |
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer --> | A cloned Layer. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} GetGoogleMapsImageCore(Double,Double,Int32,Double,Double) ** |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== Close() ==== | + | * //N/A// |
| - | This method closes the Layer and releases any resources it was using. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method CloseCore. 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 == |
| + | * Type:Bitmap | ||
| + | * Description:N/A | ||
| - | 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. | + | == Parameters == |
| - | === Return Value === | + | * //longitude// |
| - | ^ Return Type ^ Description ^ | + | * Type:Double |
| - | | Void<!-- System.Void --> | | | + | * Description:N/A |
| - | === Parameters === | + | * //latitude// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Double |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | * //zoomLevelNumber// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ==== Draw(GeoCanvas, Collection<SimpleCandidate>) ==== | + | * Description:N/A |
| - | This method draws the Layer. | + | |
| - | === 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. | + | |
| - | 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. | + | * //tileWidth// |
| - | === Return Value === | + | * Type:Double |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //tileHeight// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Double |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. | | + | * Description:N/A |
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | This parameter represents the labels used for collision detection and duplication checking. | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnCreatingRequest(CreatingRequestGoogleMapsLayerEventArgs) ** |
| - | ==== Equals(Object) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | obj | Object<!-- System.Object --> | | | + | * //N/A// |
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== GetBoundingBox() ==== | + | * Description:N/A |
| - | This method returns the bounding box of the Layer. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the RasterLayer. | + | |
| - | 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. | + | == Parameters == |
| - | === Return Value === | + | * //e// |
| - | ^ Return Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.CreatingRequestGoogleMapsLayerEventArgs|CreatingRequestGoogleMapsLayerEventArgs]] |
| - | | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | This method returns the bounding box of the Layer. | | + | * Description:N/A |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) ** |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetGoogleMapsImage(Double, Double, Int32, Double, Double) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Bitmap<!-- System.Drawing.Bitmap --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | longitude | Double<!-- System.Double --> | | | + | * Description:N/A |
| - | | latitude | Double<!-- System.Double --> | | | + | |
| - | | zoomLevelNumber | Int32<!-- System.Int32 --> | | | + | |
| - | | tileWidth | Double<!-- System.Double --> | | | + | |
| - | | tileHeight | Double<!-- System.Double --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //e// |
| - | ==== GetHashCode() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) ** |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetPictureFormat() ==== | + | * //N/A// |
| - | Get picture format string which will use for request url. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | Get picture format string which will use for request url. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //e// |
| - | ==== GetType() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** |
| - | <!-- System.Object --> | + | * //This method opens the Layer so that it is initialized and ready to use.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== LoadLayer(Uri) ==== | + | * //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.// |
| - | <!-- static --> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | layerUri | Uri<!-- System.Uri --> | | | + | * Description:None |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== LoadLayer(Stream) ==== | + | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** |
| - | <!-- static --> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer --> | | | + | |
| - | === Parameters === | + | * //This method closes the Layer and releases any resources it was using.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | layerStream | Stream<!-- System.IO.Stream --> | | | + | * //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.// |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== Open() ==== | + | * Description:None |
| - | This method opens the Layer so that it is initialized and ready to use. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method OpenCore. 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. | + | == Parameters == |
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | ||
| - | 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. | + | * //This method draws the Layer.// |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | * //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.// |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:None | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //canvas// |
| - | ==== RequestDrawing(IEnumerable<RectangleShape>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | === Return Value === | + | * Description:This parameter is the canvas object or a GeoImage to draw on. |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //labelsInAllLayers// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> | | | + | * Description:This parameter represents the labels used for collision detection and duplication checking. |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** |
| - | ==== RequestDrawing(IEnumerable<RectangleShape>, TimeSpan) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> | | | + | * //N/A// |
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== RequestDrawing(TimeSpan) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //eventArgs// |
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** |
| - | ==== RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | extentToRefresh | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | + | * //N/A// |
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | | bufferTimeType | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ==== RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //eventArgs// |
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] |
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | * Description:N/A |
| - | | bufferTimeType | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** |
| - | ==== RequestDrawing(TimeSpan, RequestDrawingBufferTimeType) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | * //N/A// |
| - | | bufferTimeType | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] |
| - | ==== RequestDrawing() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== RequestDrawing(RectangleShape) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] |
| - | | extentToRefresh | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== RequestDrawing(RectangleShape, TimeSpan) ==== | + | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | extentToRefresh | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | + | * //N/A// |
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== ToString() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ===== Protected Methods ===== | + | * //N/A// |
| - | ==== CloneDeepCore() ==== | + | |
| - | Create a copy of Layer using the deep clone process. The default implemenation uses serialization. | + | |
| - | === Remarks === | + | |
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer --> | A cloned Layer. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //canvas// |
| - | ==== CloseCore() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | This method closes the Layer and releases any resources it was using. | + | * Description:N/A |
| - | === 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. | + | * //e// |
| - | === Return Value === | + | * Type:Exception |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** |
| - | <!-- ThinkGeo.MapSuite.Core.Layer(overriden) --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== DrawAttributionCore(GeoCanvas, String) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | + | * Description:N/A |
| - | | attribution | String<!-- System.String --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //canvas// |
| - | ==== DrawCore(GeoCanvas, Collection<SimpleCandidate>) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | This method draws the Layer. | + | * Description:N/A |
| - | === 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. | + | * //e// |
| - | === Return Value === | + | * Type:Exception |
| - | ^ Return Type ^ Description ^ | + | * Description:N/A |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. | | + | |
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} --> | This parameter represents the labels used for collision detection and duplication checking. | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer(overriden) --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== DrawException(GeoCanvas, Exception) ==== | + | * //N/A// |
| - | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | + | |
| - | === Remarks === | + | |
| - | This method can be overriden its logic by rewrite the DrawExceptionCore. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | The target canvas to draw the layer. | | + | * Description:N/A |
| - | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //e// |
| - | ==== DrawExceptionCore(GeoCanvas, Exception) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] |
| - | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** |
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | The target canvas to draw the layer. | | + | |
| - | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== Finalize() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //e// |
| - | ==== GetBoundingBoxCore() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] |
| - | This method returns the bounding box of the Layer. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | This method returns the bounding box of the Layer. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | This method returns the bounding box of the Layer. | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== GetGoogleMapsImageCore(Double, Double, Int32, Double, Double) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Bitmap<!-- System.Drawing.Bitmap --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| - | | longitude | Double<!-- System.Double --> | | | + | * Description:N/A |
| - | | latitude | Double<!-- System.Double --> | | | + | |
| - | | zoomLevelNumber | Int32<!-- System.Int32 --> | | | + | |
| - | | tileWidth | Double<!-- System.Double --> | | | + | |
| - | | tileHeight | Double<!-- System.Double --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //canvas// |
| - | ==== MemberwiseClone() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
| - | === Return Value === | + | * Description:N/A |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | * //attribution// |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** |
| - | ==== OnCreatingRequest(CreatingRequestGoogleMapsLayerEventArgs) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | e | [[ThinkGeo.MapSuite.Core.CreatingRequestGoogleMapsLayerEventArgs|CreatingRequestGoogleMapsLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.CreatingRequestGoogleMapsLayerEventArgs --> | | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== OnDrawingAttribution(DrawingAttributionLayerEventArgs) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //args// |
| - | | args | [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** |
| - | ==== OnDrawingException(DrawingExceptionLayerEventArgs) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | e | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs --> | | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //args// |
| - | | e | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** |
| - | ==== OnDrawnAttribution(DrawnAttributionLayerEventArgs) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | args | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs --> | | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== OnDrawnException(DrawnExceptionLayerEventArgs) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //e// |
| - | | e | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
| + | * Description:N/A | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | ==== OnRequestedDrawing(RequestedDrawingLayerEventArgs) ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | eventArgs | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs --> | | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== OnRequestingDrawing(RequestingDrawingLayerEventArgs) ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| - | | eventArgs | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs --> | | | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== OnSendingWebRequest(SendingWebRequestEventArgs) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
| - | | e | [[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs --> | | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ==== OnSentWebRequest(SentWebRequestEventArgs) ==== | + | ==== Public Properties ==== |
| - | === Return Value === | + | ** {{wiki:PublicProperty.gif|}} TileMode ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | N/A |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | e | [[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.Core.SentWebRequestEventArgs --> | | | + | N/A |
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GoogleMapsTileMode|GoogleMapsTileMode]] | ||
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} TileWidth ** |
| - | [[#Protected Methods|Go Back]] | + | |
| - | ==== OpenCore() ==== | + | |
| - | This method opens the Layer so that it is initialized and ready to use. | + | |
| - | === 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. | + | N/A |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ Description ^ | + | N/A |
| - | | Void<!-- System.Void --> | | | + | == Return Value == |
| + | * Type:Int32 | ||
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} TileHeight ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer(overriden) --> | + | N/A |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== SendWebRequest(WebRequest) ==== | + | N/A |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ Description ^ | + | * Type:Int32 |
| - | | WebResponse<!-- System.Net.WebResponse --> | | | + | |
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} PictureFormat ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | webRequest | WebRequest<!-- System.Net.WebRequest --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | Gets or sets a value represents the image format of the image. |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== SendWebRequestCore(WebRequest) ==== | + | N/A |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GoogleMapsPictureFormat|GoogleMapsPictureFormat]] |
| - | | WebResponse<!-- System.Net.WebResponse --> | | | + | |
| - | === Parameters === | + | ** {{wiki:PublicProperty.gif|}} MapType ** |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | webRequest | WebRequest<!-- System.Net.WebRequest --> | | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | Gets or sets a value represents the map type of the GoogleMaps. |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ===== Public Properties ===== | + | N/A |
| - | ==== Attribution ==== | + | == Return Value == |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.GoogleMapsMapType|GoogleMapsMapType]] |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | ** {{wiki:PublicProperty.gif|}} TimeoutInSeconds ** |
| + | |||
| + | Gets or sets a value represents the request timeout from the GoogleMaps server. | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicProperty.gif|}} ClientId ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== BlueTranslation ==== | + | |
| - | This property gets and sets the amount of blue to apply to the image. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Single<!-- System.Single --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ClientId ==== | ||
| Gets or sets a value to access the special features of Google Maps API Premier, you must provide a client ID when accessing any of the Premier API libraries or services. When registering for Google Maps API Premier, you will receive this client ID from Google Enterprise Support. All client IDs begin with a gme- prefix. | Gets or sets a value to access the special features of Google Maps API Premier, you must provide a client ID when accessing any of the Premier API libraries or services. When registering for Google Maps API Premier, you will receive this client ID from Google Enterprise Support. All client IDs begin with a gme- prefix. | ||
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ | + | N/A |
| - | | String<!-- System.String --> | | + | == Return Value == |
| + | * Type:String | ||
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} PrivateKey ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== DrawingExceptionMode ==== | + | |
| - | Gets or sets the DrawExcpetionMode when exception happens. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionMode --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | Gets or sets a value that is unique to your client ID, please keep your key secure. |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== DrawingTime ==== | + | N/A |
| - | This property gets the last drawing time for the layer. | + | == Return Value == |
| - | === Remarks === | + | * Type:String |
| - | We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | TimeSpan<!-- System.TimeSpan --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicProperty.gif|}} TileCache ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== GreenTranslation ==== | + | |
| - | This property gets and sets the amount of green to apply to the image. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Single<!-- System.Single --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== HasBoundingBox ==== | + | N/A |
| - | This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs. | + | == Return Value == |
| - | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] |
| - | The default value is false. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicProperty.gif|}} ProjectionFromSphericalMercator ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== IsGrayscale ==== | + | |
| - | This property gets and sets if the image should be converted to grayscale. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== IsNegative ==== | + | N/A |
| - | This property gets and sets whether the image should be converted to negative (inverse colors). | + | == Return Value == |
| - | === Return Value === | + | * Type:[[ThinkGeo.MapSuite.Core.Projection|Projection]] |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicProperty.gif|}} ProjectedTileCache ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== IsOpen ==== | + | |
| - | This property returns true if the Layer is open and false if it is not. | + | |
| - | === Remarks === | + | |
| - | This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open. | + | |
| - | 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. | + | N/A |
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ | + | N/A |
| - | | Boolean<!-- System.Boolean --> | | + | == Return Value == |
| + | * Type:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | ||
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicProperty.gif|}} TileExpiration ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== IsVisible ==== | + | |
| - | This property gets and set the visible state of the layer. | + | |
| - | === Remarks === | + | |
| - | If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== KeyColors ==== | + | N/A |
| - | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors. | + | == Return Value == |
| - | === Remarks === | + | * Type:TimeSpan |
| - | It will make these colors transparent when draw image. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.GeoColor} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicProperty.gif|}} MaxCacheSizeInMegabytes ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== MapType ==== | + | |
| - | Gets or sets a value represents the map type of the GoogleMaps. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.GoogleMapsMapType|GoogleMapsMapType]]<!-- ThinkGeo.MapSuite.Core.GoogleMapsMapType --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== MaxCacheSizeInMegabytes ==== | + | N/A |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Double |
| - | | Double<!-- System.Double --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} NoDataTileImage ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== Name ==== | + | |
| - | This property gets and sets the name for the layer. | + | |
| - | === Remarks === | + | |
| - | The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== NoDataTileImage ==== | ||
| Gets or sets a value represents the image with 512*512 when no data can access. | Gets or sets a value represents the image with 512*512 when no data can access. | ||
| - | === Remarks === | + | == Remarks == |
| 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 == |
| - | ^ Return Type ^ | + | * Type:Bitmap |
| - | | Bitmap<!-- System.Drawing.Bitmap --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} WebProxy ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== PictureFormat ==== | + | |
| - | Gets or sets a value represents the image format of the image. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.GoogleMapsPictureFormat|GoogleMapsPictureFormat]]<!-- ThinkGeo.MapSuite.Core.GoogleMapsPictureFormat --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | This property gets or sets the proxy used for requesting a Web Response. |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== PrivateKey ==== | + | N/A |
| - | Gets or sets a value that is unique to your client ID, please keep your key secure. | + | == Return Value == |
| - | === Return Value === | + | * Type:WebProxy |
| - | ^ Return Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== ProjectedTileCache ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]<!-- ThinkGeo.MapSuite.Core.BitmapTileCache --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== ProjectionFromSphericalMercator ==== | + | N/A |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:TimeSpan |
| - | | [[ThinkGeo.MapSuite.Core.Projection|Projection]]<!-- ThinkGeo.MapSuite.Core.Projection --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} IsOpen ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== RedTranslation ==== | + | |
| - | This property gets and sets the amount of red to apply to the image. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Single<!-- System.Single --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== RequestDrawingInterval ==== | + | N/A |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Boolean |
| - | | TimeSpan<!-- System.TimeSpan --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicProperty.gif|}} HasBoundingBox ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== TileCache ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]<!-- ThinkGeo.MapSuite.Core.BitmapTileCache --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== TileExpiration ==== | + | N/A |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Boolean |
| - | | TimeSpan<!-- System.TimeSpan --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} DrawingTime ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== TileHeight ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== TileMode ==== | + | N/A |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:TimeSpan |
| - | | [[ThinkGeo.MapSuite.Core.GoogleMapsTileMode|GoogleMapsTileMode]]<!-- ThinkGeo.MapSuite.Core.GoogleMapsTileMode --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} Name ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== TileWidth ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== TimeoutInSeconds ==== | + | N/A |
| - | Gets or sets a value represents the request timeout from the GoogleMaps server. | + | == Return Value == |
| - | === Return Value === | + | * Type:String |
| - | ^ Return Type ^ | + | |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} Attribution ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== Transparency ==== | + | |
| - | This property gets and sets the amount of transparency to apply to the image. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Single<!-- System.Single --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | N/A |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ==== WebProxy ==== | + | N/A |
| - | This property gets or sets the proxy used for requesting a Web Response. | + | == Return Value == |
| - | === Return Value === | + | * Type:String |
| - | ^ Return Type ^ | + | |
| - | | WebProxy<!-- System.Net.WebProxy --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicProperty.gif|}} IsVisible ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | |
| - | ==== BufferImages ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Dictionary<Int32,Bitmap><!-- System.Collections.Generic.Dictionary{System.Int32,System.Drawing.Bitmap} --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | N/A |
| - | [[#Protected Properties|Go Back]] | + | == Remarks == |
| - | ==== IsOpenCore ==== | + | N/A |
| - | This property returns true if the Layer is open and false if it is not. | + | == Return Value == |
| - | === Remarks === | + | * Type:Boolean |
| - | Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicProperty.gif|}} Transparency ** |
| - | [[#Protected Properties|Go Back]] | + | |
| - | ===== Public Events ===== | + | N/A |
| - | ==== CreatingRequest ==== | + | == Remarks == |
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} RedTranslation ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} KeyColors ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} IsNegative ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * 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 ==== | ||
| + | ** {{wiki:ProtectedProperty.gif|}} BufferImages ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Dictionary<Int32,Bitmap> | ||
| + | |||
| + | ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ==== Public Events ==== | ||
| + | ** {{wiki:PublicEvent.gif|}} CreatingRequest ** | ||
| This event is called before creating the reqeust for google maps. | This event is called before creating the reqeust for google maps. | ||
| - | === Remarks === | + | == Remarks == |
| - | This event is called before creating the reqeust for google maps. | + | This event is called before creating the reqeust for google maps. It is typical that user want to get the url of reqeust and modify it according to their requirements. |
| - | It is typical that user want to get the url of reqeust and modify it according to their requirements. | + | |
| - | === Event Arguments === | + | Event Arguments:[[ThinkGeo.MapSuite.Core.CreatingRequestGoogleMapsLayerEventArgs|CreatingRequestGoogleMapsLayerEventArgs]] |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.CreatingRequestGoogleMapsLayerEventArgs|CreatingRequestGoogleMapsLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.CreatingRequestGoogleMapsLayerEventArgs --> | | + | ** {{wiki:PublicEvent.gif|}} SendingWebRequest ** |
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | |||
| + | Event Arguments:[[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] | ||
| + | |||
| + | ** {{wiki:PublicEvent.gif|}} SentWebRequest ** | ||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | |||
| + | Event Arguments:[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] | ||
| + | |||
| + | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** | ||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | |||
| + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | ||
| + | |||
| + | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** | ||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | |||
| + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | ||
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** |
| - | [[#Public Events|Go Back]] | + | N/A |
| - | ==== DrawingAttribution ==== | + | == Remarks == |
| - | === Event Arguments === | + | N/A |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== DrawingException ==== | + | |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicEvent.gif|}} DrawingException ** |
| - | [[#Public Events|Go Back]] | + | N/A |
| - | ==== DrawingProgressChanged ==== | + | == Remarks == |
| - | === Event Arguments === | + | N/A |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== DrawnAttribution ==== | + | |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicEvent.gif|}} DrawnException ** |
| - | [[#Public Events|Go Back]] | + | N/A |
| - | ==== DrawnException ==== | + | == Remarks == |
| - | === Event Arguments === | + | N/A |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== RequestedDrawing ==== | + | |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** |
| - | [[#Public Events|Go Back]] | + | N/A |
| - | ==== RequestingDrawing ==== | + | == Remarks == |
| - | === Event Arguments === | + | N/A |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | ==== SendingWebRequest ==== | + | |
| - | === Event Arguments === | + | |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** |
| - | [[#Public Events|Go Back]] | + | N/A |
| - | ==== SentWebRequest ==== | + | == Remarks == |
| - | === Event Arguments === | + | N/A |
| - | ^ Event Arguments ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.Core.SentWebRequestEventArgs --> | | + | |
| - | <!-- ThinkGeo.MapSuite.Core.GoogleMapsLayer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] |
| - | [[#Public Events|Go Back]] | + | |
| - | __NOTOC__ | ||
| - | [[Category:MapSuiteCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.Core]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.core.googlemapslayer.1440040128.txt.gz · Last modified: 2015/09/17 10:30 (external edit)