This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.portablecore.worldmapkitlayer [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.portablecore.worldmapkitlayer [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer ====== | + | ====== ThinkGeo.MapSuite.Core.WorldMapKitLayer ====== |
+ | {{section>upgrade_map_suite_to_10.0}} | ||
- | |||
- | <!-- Class --> | ||
This class is use for world map kit, and you also can get map from ThinkGeo world map kit server. | This class is use for world map kit, and you also can get map from ThinkGeo world map kit server. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **[[ThinkGeo.MapSuite.PortableCore.Layer]] | + | *ThinkGeo.MapSuite.Core.Layer |
- | ***[[ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer]] | + | ***ThinkGeo.MapSuite.Core.WorldMapKitLayer** |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} WorldMapKitLayer() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#WorldMapKitLayer()|WorldMapKitLayer]] | | | The default constructor | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#WorldMapKitLayer(String, String)|WorldMapKitLayer]] | String, String | | This is the constructor the for the class. | | + | |
- | ==== Protected Constructors ==== | + | * //The default constructor// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //The constructor initilizes the properties. UpperThreshold is set to double.MaxValue, LowerThreshold is set to double.MinValue.// | ||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} WorldMapKitLayer(String,String) ** | ||
+ | * //This is the constructor the for the class.// | ||
+ | == Remarks == | ||
+ | * //This constructor initializes a new layer and assgin a license key.// | ||
+ | == Parameters == | ||
+ | * //clientId// | ||
+ | * Type:String | ||
+ | * Description:The clientId for the WorldMapKit Server. | ||
+ | |||
+ | * //privateKey// | ||
+ | * Type:String | ||
+ | * Description:The privateKey for the WorldMapKit Server. | ||
+ | |||
+ | <div newline></div> | ||
+ | ==== Protected Constructors ==== | ||
==== Public Methods ==== | ==== Public Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ClearCache() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ClearCache()|ClearCache]] | | | This method clears the tile cache. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | Create a copy of Layer using the deep clone process. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.Layer|Layer]] | This method returns the bounding box of the Layer. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRequestUrl(RectangleShape, Int32, Int32)|GetRequestUrl]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], Int32, Int32 | | Get the request URLs from the client to the WMS servers. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetServerCrss()|GetServerCrss]] | | | This method returns the projected or geographic coordinate reference systems to be used. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetServerExceptionFormats()|GetServerExceptionFormats]] | | | This method returns the exception format at the server side. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetServerLayerNames()|GetServerLayerNames]] | | | This method returns the names of all layers at the server side. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetServerOutputFormats()|GetServerOutputFormats]] | | | This method returns the output format at the server side. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetServerStyleNames()|GetServerStyleNames]] | | | This method returns the names of all styles at the server side. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetServiceVersion()|GetServiceVersion]] | | | This API gets the WMS server version of the service. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method opens the Layer so that it is initialized and ready to use. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing()|RequestDrawing]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape)|RequestDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]> | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan)|RequestDrawing]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]>, TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan)|RequestDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
+ | * //This method clears the tile cache.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetServerLayerNames() ** | ||
+ | |||
+ | * //This method returns the names of all layers at the server side.// | ||
+ | == Remarks == | ||
+ | * //None.// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Collection<String> | ||
+ | * Description:This method returns the names of all layers at the server side. | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetServerStyleNames() ** | ||
+ | |||
+ | * //This method returns the names of all styles at the server side.// | ||
+ | == Remarks == | ||
+ | * //None.// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Collection<String> | ||
+ | * Description:This method returns the names of all styles at the server side. | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetServerOutputFormats() ** | ||
+ | |||
+ | * //This method returns the output format at the server side.// | ||
+ | == Remarks == | ||
+ | * //None.// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Collection<String> | ||
+ | * Description:This method returns the output format at the server side. | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetServerCrss() ** | ||
+ | |||
+ | * //This method returns the projected or geographic coordinate reference systems to be used.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Collection<String> | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetServerExceptionFormats() ** | ||
+ | |||
+ | * //This method returns the exception format at the server side.// | ||
+ | == Remarks == | ||
+ | * //None.// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Collection<String> | ||
+ | * Description:The exception format at the server side. | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetServiceVersion() ** | ||
+ | |||
+ | * //This API gets the WMS server version of the service.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | * Description:Returns a string reflecting the version of the service in WMS. | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetRequestUrl(RectangleShape,Int32,Int32) ** | ||
+ | |||
+ | * //Get the request URLs from the client to the WMS servers.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Collection<String> | ||
+ | * Description:The request URLs from the client to the WMS servers. | ||
+ | |||
+ | == Parameters == | ||
+ | * //worldExtent// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * Description:The world extent requested by the client to get the map. | ||
+ | |||
+ | * //canvasWidth// | ||
+ | * Type:Int32 | ||
+ | * Description:The returning map width, as well as the drawing canvas width. | ||
+ | |||
+ | * //canvasHeight// | ||
+ | * Type:Int32 | ||
+ | * Description:The returning map height, as well as the drawing canvas height. | ||
+ | |||
+ | <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|}} 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(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(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|}} 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|}} OpenCore() ** |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]] | | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.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.PortableCore.GeoCanvas|GeoCanvas]], String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(GeoCanvas, Collection<SimpleCandidate>)|DrawCore]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | This method draws the Layer. | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawException(GeoCanvas, Exception)|DrawException]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.PortableCore.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.PortableCore.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | 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}}[[#DrawImage(GeoCanvas, Collection<SimpleCandidate>)|DrawImage]] | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]> | | This method draws image on the canvas with specified labelsInAllLayers | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This method returns the bounding box of the Layer. | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetThreadSafetyLevelCore()|GetThreadSafetyLevelCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}{{wiki:Static.gif|Static Member}}[[#IsExtentWithinThreshold(RectangleShape, Double, Double, Int32, GeographyUnit)|IsExtentWithinThreshold]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], Double, Double, Int32, [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]] | | This method retures a value represents whether the currentExtent is within the passing in thresholds. | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}{{wiki:Static.gif|Static Member}}[[#IsExtentWithinThreshold(RectangleShape, Double, Double, Int32, GeographyUnit, Single)|IsExtentWithinThreshold]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], Double, Double, Int32, [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]], Single | | This method retures a value represents whether the currentExtent is within the passing in thresholds. | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingAttribution(DrawingAttributionLayerEventArgs)|OnDrawingAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingException(DrawingExceptionLayerEventArgs)|OnDrawingException]] | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingProgressChanged(DrawingProgressChangedEventArgs)|OnDrawingProgressChanged]] | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnAttribution(DrawnAttributionLayerEventArgs)|OnDrawnAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnException(DrawnExceptionLayerEventArgs)|OnDrawnException]] | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestedDrawing(RequestedDrawingLayerEventArgs)|OnRequestedDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestingDrawing(RequestingDrawingLayerEventArgs)|OnRequestingDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnSendingWebRequest(SendingWebRequestEventArgs)|OnSendingWebRequest]] | [[ThinkGeo.MapSuite.PortableCore.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] | | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnSentWebRequest(SentWebRequestEventArgs)|OnSentWebRequest]] | [[ThinkGeo.MapSuite.PortableCore.SentWebRequestEventArgs|SentWebRequestEventArgs]] | | | | + | |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | This method opens the Layer so that it is initialized and ready to use. | | + | |
- | ==== Public Properties ==== | + | * //This method opens the Layer so that it is initialized and ready to use.// |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | == Remarks == |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | * //This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.// |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#ClientId|ClientId]] | String | | Gets or sets a value that is your Client Id. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | Gets or sets the DrawExcpetionMode when exception happens. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingTime|DrawingTime]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets the last drawing time for the layer. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#HasBoundingBox|HasBoundingBox]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | 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.PortableCore.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.PortableCore.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.PortableCore.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.PortableCore.Layer|Layer]] | This property gets and set the visible state of the layer. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#LayerType|LayerType]] | [[ThinkGeo.MapSuite.PortableCore.WorldMapKitLayerType|WorldMapKitLayerType]] | | | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#LowerThreshold|LowerThreshold]] | Double | | Gets or sets a value represents lower threshold for scale. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and sets the name for the layer. | | + | |
- | | {{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}}[[#Projection|Projection]] | [[ThinkGeo.MapSuite.PortableCore.WorldMapKitProjection|WorldMapKitProjection]] | | | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Proxy|Proxy]] | [[ThinkGeo.MapSuite.PortableCore.GeoWebProxy|GeoWebProxy]] | | This property gets or sets the proxy used for requesting a Web Response. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#RequestDrawingInterval|RequestDrawingInterval]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#TileCache|TileCache]] | [[ThinkGeo.MapSuite.PortableCore.BitmapTileCache|BitmapTileCache]] | | Gets or sets a BitmapTileCache represents which tile cache will be use. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#TimeoutInSecond|TimeoutInSecond]] | Int32 | | This property specifies the timeout of the web request in seconds. The default timeout value is 20 seconds. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Transparency|Transparency]] | Single | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | This property gets and sets the amount of transparency to apply to the image. | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#UpperThreshold|UpperThreshold]] | Double | | Gets or sets a value represents upper threshold for scale. | | + | |
- | ==== Protected Properties ==== | + | == Return Value == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Void |
- | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOpenCore|IsOpenCore]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | This property returns true if the Layer is open and false if it is not. | | + | * Description:None |
- | ==== Public Events ==== | + | == Parameters == |
- | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
- | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingAttribution|DrawingAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** |
- | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingException|DrawingException]] | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingProgressChanged|DrawingProgressChanged]] | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnAttribution|DrawnAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnException|DrawnException]] | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestedDrawing|RequestedDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestingDrawing|RequestingDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | + | |
- | | {{wiki:PublicEvent.gif|Public Event}}[[#SendingWebRequest|SendingWebRequest]] | [[ThinkGeo.MapSuite.PortableCore.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] | | | | + | |
- | | {{wiki:PublicEvent.gif|Public Event}}[[#SentWebRequest|SentWebRequest]] | [[ThinkGeo.MapSuite.PortableCore.SentWebRequestEventArgs|SentWebRequestEventArgs]] | | | | + | |
- | ===== Public Constructors ===== | + | * //This method closes the Layer and releases any resources it was using.// |
- | ==== WorldMapKitLayer() ==== | + | == Remarks == |
- | The default constructor | + | * //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.// |
- | === Remarks === | + | |
- | The constructor initilizes the properties. UpperThreshold is set to double.MaxValue, LowerThreshold is set to double.MinValue. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | [[#Public Constructors|Go Back]] | + | == Return Value == |
- | ==== WorldMapKitLayer(String, String) ==== | + | * Type:Void |
- | This is the constructor the for the class. | + | * Description:None |
- | === Remarks === | + | |
- | This constructor initializes a new layer and assgin a license key. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | clientId | String<!-- System.String --> | The clientId for the WorldMapKit Server. | | + | |
- | | privateKey | String<!-- System.String --> | The privateKey for the WorldMapKit Server. | | + | |
- | [[#Public Constructors|Go Back]] | + | == Parameters == |
- | ===== Protected Constructors ===== | + | <div newline></div> |
- | ===== Public Methods ===== | + | ** {{wiki:ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) ** |
- | ==== ClearCache() ==== | + | |
- | This method clears the tile cache. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | ==== 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.PortableCore.Layer|Layer]]<!-- ThinkGeo.MapSuite.PortableCore.Layer --> | A cloned Layer. | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //e// |
+ | * Type:[[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] | ||
+ | * Description:N/A | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) ** |
- | ==== Close() ==== | + | |
- | 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. | + | * //N/A// |
+ | == Remarks == | ||
+ | * //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. | + | == Return Value == |
- | === Return Value === | + | * Type:Void |
- | ^ Return Type ^ Description ^ | + | * Description:N/A |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //e// |
+ | * Type:[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] | ||
+ | * Description:N/A | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} DrawImage(GeoCanvas,Collection<SimpleCandidate>) ** |
- | ==== Draw(GeoCanvas, Collection<SimpleCandidate>) ==== | + | |
- | 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. | + | * //This method draws image on the canvas with specified labelsInAllLayers// |
- | === Return Value === | + | == Remarks == |
- | ^ Return Type ^ Description ^ | + | * //N/A// |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. | | + | * Description:N/A |
- | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | This parameter represents the labels used for collision detection and duplication checking. | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //canvas// |
- | ==== Equals(Object) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
- | === Return Value === | + | * Description:This parameter is the canvas object or a GeoImage to draw on. This parameter represents the labels used for collision detection and duplication checking. |
- | ^ Return Type ^ Description ^ | + | |
- | | Boolean<!-- System.Boolean --> | | | + | |
- | === Parameters === | + | * //labelsInAllLayers// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
- | | obj | Object<!-- System.Object --> | | | + | * Description:This parameter is the labels in all layers. |
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** |
- | ==== GetBoundingBox() ==== | + | |
- | 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. | + | * //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.// |
- | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns the bounding box of the Layer. | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
+ | * Description:None | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //canvas// |
- | ==== GetHashCode() ==== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
- | === Return Value === | + | * Description:This parameter is the canvas object or a GeoImage to draw on. |
- | ^ Return Type ^ Description ^ | + | |
- | | Int32<!-- System.Int32 --> | | | + | |
- | === Parameters === | + | * //labelsInAllLayers// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> |
+ | * Description:This parameter represents the labels used for collision detection and duplication checking. | ||
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** |
- | ==== GetRequestUrl(RectangleShape, Int32, Int32) ==== | + | |
- | Get the request URLs from the client to the WMS servers. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | The request URLs from the client to the WMS servers. | | + | |
- | === Parameters === | + | * //This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | worldExtent | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | The world extent requested by the client to get the map. | | + | * //N/A// |
- | | canvasWidth | Int32<!-- System.Int32 --> | The returning map width, as well as the drawing canvas width. | | + | |
- | | canvasHeight | Int32<!-- System.Int32 --> | The returning map height, as well as the drawing canvas height. | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | ==== GetServerCrss() ==== | + | * Description:N/A |
- | This method returns the projected or geographic coordinate reference systems to be used. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //canvas// |
+ | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
+ | * Description:The target canvas to draw the layer. | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | * //e// |
- | [[#Public Methods|Go Back]] | + | * Type:Exception |
- | ==== GetServerExceptionFormats() ==== | + | * Description:The exception thrown when layer.Draw(). |
- | This method returns the exception format at the server side. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | The exception format at the server side. | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== GetServerLayerNames() ==== | + | * //N/A// |
- | This method returns the names of all layers at the server side. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns the names of all layers at the server side. | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] |
+ | * Description:N/A | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | ==== GetServerOutputFormats() ==== | + | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** |
- | This method returns the output format at the server side. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns the output format at the server side. | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | ==== GetServerStyleNames() ==== | + | * Description:N/A |
- | This method returns the names of all styles at the server side. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns the names of all styles at the server side. | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //eventArgs// |
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | ||
+ | * Description:N/A | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** |
- | ==== GetServiceVersion() ==== | + | |
- | This API gets the WMS server version of the service. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | Returns a string reflecting the version of the service in WMS. | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] |
- | ==== GetType() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Type<!-- System.Type --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
+ | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
- | <!-- System.Object --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== Open() ==== | + | * //N/A// |
- | 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. | + | == Return Value == |
+ | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
+ | * 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 === | + | <div newline></div> |
- | ^ Return Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | ==== RequestDrawing() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //canvas// |
+ | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
+ | * Description:N/A | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //e// |
- | [[#Public Methods|Go Back]] | + | * Type:Exception |
- | ==== RequestDrawing(RectangleShape) ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** |
- | | extentToRefresh | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== RequestDrawing(IEnumerable<RectangleShape>) ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
- | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | | | + | * Description:N/A |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //e// |
- | ==== RequestDrawing(TimeSpan) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] |
- | === Return Value === | + | * Description:N/A |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** |
- | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== RequestDrawing(IEnumerable<RectangleShape>, TimeSpan) ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
- | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | | | + | * Description:N/A |
- | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //e// |
- | ==== RequestDrawing(RectangleShape, TimeSpan) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] |
- | === Return Value === | + | * Description:N/A |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** |
- | | extentToRefresh | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | + | |
- | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== ToString() ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //canvas// |
- | ===== Protected Methods ===== | + | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] |
- | ==== CloneDeepCore() ==== | + | * Description:N/A |
- | 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.PortableCore.Layer|Layer]]<!-- ThinkGeo.MapSuite.PortableCore.Layer --> | A cloned Layer. | | + | |
- | === Parameters === | + | * //attribution// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:String |
+ | * Description:N/A | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | <div newline></div> |
- | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** |
- | ==== CloseCore() ==== | + | |
- | This method closes the Layer and releases any resources it was using. | + | |
- | === 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. | + | * //N/A// |
- | === Return Value === | + | == Remarks == |
- | ^ Return Type ^ Description ^ | + | * //N/A// |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
+ | * Description:N/A | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | == Parameters == |
- | [[#Protected Methods|Go Back]] | + | * //args// |
- | ==== DrawAttributionCore(GeoCanvas, String) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] |
- | === Return Value === | + | * Description:N/A |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** |
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | | | + | |
- | | attribution | String<!-- System.String --> | | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ==== DrawCore(GeoCanvas, Collection<SimpleCandidate>) ==== | + | * //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. | + | |
- | When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection. | + | == Return Value == |
- | === Return Value === | + | * Type:Void |
- | ^ Return Type ^ Description ^ | + | * Description:N/A |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //args// |
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. | | + | * Type:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] |
- | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | This parameter represents the labels used for collision detection and duplication checking. | | + | * Description:N/A |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | <div newline></div> |
- | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** |
- | ==== DrawException(GeoCanvas, Exception) ==== | + | |
- | 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 === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | The target canvas to draw the layer. | | + | * //N/A// |
- | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Void |
- | ==== DrawExceptionCore(GeoCanvas, Exception) ==== | + | * Description: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. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //e// |
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | The target canvas to draw the layer. | | + | * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
- | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | + | * Description:N/A |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | <div newline></div> |
- | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** |
- | ==== DrawImage(GeoCanvas, Collection<SimpleCandidate>) ==== | + | |
- | This method draws image on the canvas with specified labelsInAllLayers | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. This parameter represents the labels used for collision detection and duplication checking. | | + | * //N/A// |
- | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | This parameter is the labels in all layers. | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Void |
- | ==== Finalize() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //eventArgs// |
+ | * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | ||
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | ==== GetBoundingBoxCore() ==== | + | |
- | This method returns the bounding box of the Layer. | + | |
- | === Remarks === | + | |
- | This method returns the bounding box of the Layer. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns the bounding box of the Layer. | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Void |
- | ==== GetThreadSafetyLevelCore() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.ThreadSafetyLevel|ThreadSafetyLevel]]<!-- ThinkGeo.MapSuite.PortableCore.ThreadSafetyLevel --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
+ | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | * //N/A// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ==== IsExtentWithinThreshold(RectangleShape, Double, Double, Int32, GeographyUnit) ==== | + | * //N/A// |
- | <!-- static --> | + | |
- | This method retures a value represents whether the currentExtent is within the passing in thresholds. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Boolean<!-- System.Boolean --> | This method retures a value represents whether the currentExtent is within the passing in thresholds. If returns true, is within. otherwise out of thresholds. | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
- | | currentExtent | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | The RectangleShape represents the current extent. | | + | * Description:N/A |
- | | upperThreshold | Double<!-- System.Double --> | The upper threshold for scale. | | + | |
- | | lowerThreshold | Double<!-- System.Double --> | The lower threshold for scale. | | + | |
- | | canvasWidth | Int32<!-- System.Int32 --> | The width of canvas which will use to draw. | | + | |
- | | mapUnit | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | The GeographyUnit represents map unit for currentExtent | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | == Parameters == |
- | [[#Protected Methods|Go Back]] | + | <div newline></div> |
- | ==== IsExtentWithinThreshold(RectangleShape, Double, Double, Int32, GeographyUnit, Single) ==== | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsEqual(Double,Double) ** |
- | <!-- static --> | + | |
- | This method retures a value represents whether the currentExtent is within the passing in thresholds. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Boolean<!-- System.Boolean --> | This method retures a value represents whether the currentExtent is within the passing in thresholds. If returns true, is within. otherwise out of thresholds. | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | currentExtent | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | The RectangleShape represents the current extent. | | + | * //N/A// |
- | | upperThreshold | Double<!-- System.Double --> | The upper threshold for scale. | | + | |
- | | lowerThreshold | Double<!-- System.Double --> | The lower threshold for scale. | | + | |
- | | canvasWidth | Int32<!-- System.Int32 --> | The width of canvas which will use to draw. | | + | |
- | | mapUnit | [[ThinkGeo.MapSuite.PortableCore.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.PortableCore.GeographyUnit --> | The GeographyUnit represents map unit for currentExtent | | + | |
- | | dpi | Single<!-- System.Single --> | This parameter is the dpi of the current extent. | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Boolean |
- | ==== MemberwiseClone() ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //firstValue// |
+ | * Type:Double | ||
+ | * Description:N/A | ||
- | <!-- System.Object --> | + | * //secondValue// |
- | [[#Protected Methods|Go Back]] | + | * Type:Double |
- | ==== OnDrawingAttribution(DrawingAttributionLayerEventArgs) ==== | + | * Description:N/A |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} Contains(RectangleShape,RectangleShape) ** |
- | | args | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs --> | | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //N/A// |
- | [[#Protected Methods|Go Back]] | + | == Remarks == |
- | ==== OnDrawingException(DrawingExceptionLayerEventArgs) ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Boolean |
- | | e | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs --> | | | + | * Description:N/A |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Parameters == |
- | [[#Protected Methods|Go Back]] | + | * //extent// |
- | ==== OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ==== | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | === Return Value === | + | * Description:N/A |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //targetExtent// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
- | | e | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | | + | * Description:N/A |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | <div newline></div> |
- | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit) ** |
- | ==== OnDrawnAttribution(DrawnAttributionLayerEventArgs) ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //This method retures a value represents whether the currentExtent is within the passing in thresholds.// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | args | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs --> | | | + | * //N/A// |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Boolean |
- | ==== OnDrawnException(DrawnExceptionLayerEventArgs) ==== | + | * Description:This method retures a value represents whether the currentExtent is within the passing in thresholds. If returns true, is within. otherwise out of thresholds. |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //currentExtent// |
- | | e | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
+ | * Description:The RectangleShape represents the current extent. | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //upperThreshold// |
- | [[#Protected Methods|Go Back]] | + | * Type:Double |
- | ==== OnRequestedDrawing(RequestedDrawingLayerEventArgs) ==== | + | * Description:The upper threshold for scale. |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //lowerThreshold// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Double |
- | | eventArgs | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs --> | | | + | * Description:The lower threshold for scale. |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //canvasWidth// |
- | [[#Protected Methods|Go Back]] | + | * Type:Int32 |
- | ==== OnRequestingDrawing(RequestingDrawingLayerEventArgs) ==== | + | * Description:The width of canvas which will use to draw. |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //mapUnit// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
- | | eventArgs | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs --> | | | + | * Description:The GeographyUnit represents map unit for currentExtent |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | <div newline></div> |
- | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} IsExtentWithinThreshold(RectangleShape,Double,Double,Int32,GeographyUnit,Single) ** |
- | ==== OnSendingWebRequest(SendingWebRequestEventArgs) ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //This method retures a value represents whether the currentExtent is within the passing in thresholds.// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | e | [[ThinkGeo.MapSuite.PortableCore.SendingWebRequestEventArgs|SendingWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.SendingWebRequestEventArgs --> | | | + | * //N/A// |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | == Return Value == |
- | [[#Protected Methods|Go Back]] | + | * Type:Boolean |
- | ==== OnSentWebRequest(SentWebRequestEventArgs) ==== | + | * Description:This method retures a value represents whether the currentExtent is within the passing in thresholds. If returns true, is within. otherwise out of thresholds. |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //currentExtent// |
- | | e | [[ThinkGeo.MapSuite.PortableCore.SentWebRequestEventArgs|SentWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.SentWebRequestEventArgs --> | | | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
+ | * Description:The RectangleShape represents the current extent. | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | * //upperThreshold// |
- | [[#Protected Methods|Go Back]] | + | * Type:Double |
- | ==== OpenCore() ==== | + | * Description:The upper threshold for scale. |
- | 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. | + | * //lowerThreshold// |
- | === Return Value === | + | * Type:Double |
- | ^ Return Type ^ Description ^ | + | * Description:The lower threshold for scale. |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //canvasWidth// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
+ | * Description:The width of canvas which will use to draw. | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | * //mapUnit// |
- | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]] |
- | ===== Public Properties ===== | + | * Description:The GeographyUnit represents map unit for currentExtent |
- | ==== Attribution ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //dpi// |
- | [[#Public Properties|Go Back]] | + | * Type:Single |
- | ==== ClientId ==== | + | * Description:This parameter is the dpi of the current extent. |
- | Gets or sets a value that is your Client Id. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | <div newline></div> |
- | [[#Public Properties|Go Back]] | + | ==== Public Properties ==== |
- | ==== DrawingExceptionMode ==== | + | ** {{wiki:PublicProperty.gif|}} ClientId ** |
- | Gets or sets the DrawExcpetionMode when exception happens. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode|DrawingExceptionMode]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionMode --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //Gets or sets a value that is your Client Id.// |
- | [[#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.PortableCore.Layer --> | + | ** {{wiki:PublicProperty.gif|}} PrivateKey ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== HasBoundingBox ==== | + | |
- | 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. | + | |
- | === Remarks === | + | |
- | The value of WorldMapKitLayer is false. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Boolean<!-- System.Boolean --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | + | * //Gets or sets a value that is unique to your client ID, please keep your key secure.// |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== IsGrayscale ==== | + | * //N/A// |
- | This property gets and sets if the image should be converted to grayscale. | + | == Return Value == |
- | === Return Value === | + | * Type:String |
- | ^ Return Type ^ | + | |
- | | Boolean<!-- System.Boolean --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicProperty.gif|}} LayerType ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== IsNegative ==== | + | |
- | This property gets and sets whether the image should be converted to negative (inverse colors). | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Boolean<!-- System.Boolean --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //Gets or sets a value for WorldMapKitLayer type.// |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== IsOpen ==== | + | * //N/A// |
- | This property returns true if the Layer is open and false if it is not. | + | == Return Value == |
- | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitLayerType|WorldMapKitLayerType]] |
- | 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. | + | ** {{wiki:PublicProperty.gif|}} Projection ** |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Boolean<!-- System.Boolean --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | * //Gets or sets a WorldMapKitProjection represents which projection will be use.// |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== IsVisible ==== | + | * //N/A// |
- | This property gets and set the visible state of the layer. | + | == Return Value == |
- | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitProjection|WorldMapKitProjection]] |
- | 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.PortableCore.Layer --> | + | ** {{wiki:PublicProperty.gif|}} Proxy ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== LayerType ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.WorldMapKitLayerType|WorldMapKitLayerType]]<!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayerType --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | * //This property gets or sets the proxy used for requesting a Web Response.// |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== LowerThreshold ==== | + | * //N/A// |
- | Gets or sets a value represents lower threshold for scale. | + | == Return Value == |
- | === Remarks === | + | * Type:[[ThinkGeo.MapSuite.Core.GeoWebProxy|GeoWebProxy]] |
- | Is the current scale is less than this value, the map will not render. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Double<!-- System.Double --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | ** {{wiki:PublicProperty.gif|}} TileCache ** |
- | [[#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.PortableCore.Layer --> | + | * //Gets or sets a BitmapTileCache represents which tile cache will be use.// |
- | [[#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:[[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] |
- | ^ Return Type ^ | + | |
- | | String<!-- System.String --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | ** {{wiki:PublicProperty.gif|}} UpperThreshold ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== Projection ==== | + | * //Gets or sets a value represents upper threshold for scale.// |
- | === Return Value === | + | == Remarks == |
- | ^ Return Type ^ | + | * //Is the current scale is beyond this value, the map will not render.// |
- | | [[ThinkGeo.MapSuite.PortableCore.WorldMapKitProjection|WorldMapKitProjection]]<!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitProjection --> | | + | == Return Value == |
+ | * Type:Double | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} LowerThreshold ** | ||
+ | |||
+ | * //Gets or sets a value represents lower threshold for scale.// | ||
+ | == Remarks == | ||
+ | * //Is the current scale is less than this value, the map will not render.// | ||
+ | == Return Value == | ||
+ | * Type:Double | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} TimeoutInSecond ** | ||
+ | |||
+ | * //This property specifies the timeout of the web request in seconds. The default timeout value is 20 seconds.// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:Int32 | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} HasBoundingBox ** | ||
+ | |||
+ | * //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.// | ||
+ | == Remarks == | ||
+ | * //The value of WorldMapKitLayer is false.// | ||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} IsOpen ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} DrawingTime ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:TimeSpan | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Name ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} IsVisible ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Transparency ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:Single | ||
+ | |||
+ | ** {{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]] | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} Attribution ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:TimeSpan | ||
+ | |||
+ | ==== Protected Properties ==== | ||
+ | ** {{wiki:ProtectedProperty.gif|}} ImageSource ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.WorldMapKitWmsRasterSource|WorldMapKitWmsRasterSource]] | ||
+ | |||
+ | ** {{wiki:ProtectedProperty.gif|}} ActiveLayerNames ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:Collection<String> | ||
+ | |||
+ | ** {{wiki:ProtectedProperty.gif|}} ActiveStyleNames ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:Collection<String> | ||
+ | |||
+ | ** {{wiki:ProtectedProperty.gif|}} Parameters ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Return Value == | ||
+ | * Type:Dictionary<String,String> | ||
+ | |||
+ | ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** | ||
+ | |||
+ | * //This property returns true if the Layer is open and false if it is not.// | ||
+ | == Remarks == | ||
+ | * //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 == | ||
+ | * Type:Boolean | ||
+ | |||
+ | ==== Public Events ==== | ||
+ | ** {{wiki:PublicEvent.gif|}} SendingWebRequest ** | ||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] |
- | [[#Public Properties|Go Back]] | + | |
- | ==== Proxy ==== | + | |
- | This property gets or sets the proxy used for requesting a Web Response. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.GeoWebProxy|GeoWebProxy]]<!-- ThinkGeo.MapSuite.PortableCore.GeoWebProxy --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | ** {{wiki:PublicEvent.gif|}} SentWebRequest ** |
- | [[#Public Properties|Go Back]] | + | * //N/A// |
- | ==== RequestDrawingInterval ==== | + | == Remarks == |
- | === Return Value === | + | * //N/A// |
- | ^ Return Type ^ | + | |
- | | TimeSpan<!-- System.TimeSpan --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] |
- | [[#Public Properties|Go Back]] | + | |
- | ==== TileCache ==== | + | |
- | Gets or sets a BitmapTileCache represents which tile cache will be use. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.BitmapTileCache|BitmapTileCache]]<!-- ThinkGeo.MapSuite.PortableCore.BitmapTileCache --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | ** {{wiki:PublicEvent.gif|}} DrawingException ** |
- | [[#Public Properties|Go Back]] | + | * //N/A// |
- | ==== TimeoutInSecond ==== | + | == Remarks == |
- | This property specifies the timeout of the web request in seconds. The default timeout value is 20 seconds. | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Int32<!-- System.Int32 --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] |
- | [[#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.PortableCore.Layer --> | + | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** |
- | [[#Public Properties|Go Back]] | + | * //N/A// |
- | ==== UpperThreshold ==== | + | == Remarks == |
- | Gets or sets a value represents upper threshold for scale. | + | * //N/A// |
- | === Remarks === | + | |
- | Is the current scale is beyond this value, the map will not render. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Double<!-- System.Double --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] |
- | [[#Public Properties|Go Back]] | + | |
- | ===== Protected Properties ===== | + | |
- | ==== IsOpenCore ==== | + | |
- | This property returns true if the Layer is open and false if it is not. | + | |
- | === Remarks === | + | |
- | 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.PortableCore.Layer(overriden) --> | + | ** {{wiki:PublicEvent.gif|}} DrawnException ** |
- | [[#Protected Properties|Go Back]] | + | * //N/A// |
- | ===== Public Events ===== | + | == Remarks == |
- | ==== DrawingAttribution ==== | + | * //N/A// |
- | === Event Arguments === | + | |
- | ^ Event Arguments ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] |
- | [[#Public Events|Go Back]] | + | |
- | ==== DrawingException ==== | + | |
- | === Event Arguments === | + | |
- | ^ Event Arguments ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** |
- | [[#Public Events|Go Back]] | + | * //N/A// |
- | ==== DrawingProgressChanged ==== | + | == Remarks == |
- | === Event Arguments === | + | * //N/A// |
- | ^ Event Arguments ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] |
- | [[#Public Events|Go Back]] | + | |
- | ==== DrawnAttribution ==== | + | |
- | === Event Arguments === | + | |
- | ^ Event Arguments ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** |
- | [[#Public Events|Go Back]] | + | * //N/A// |
- | ==== DrawnException ==== | + | == Remarks == |
- | === Event Arguments === | + | * //N/A// |
- | ^ Event Arguments ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] |
- | [[#Public Events|Go Back]] | + | |
- | ==== RequestedDrawing ==== | + | |
- | === Event Arguments === | + | |
- | ^ Event Arguments ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** |
- | [[#Public Events|Go Back]] | + | * //N/A// |
- | ==== RequestingDrawing ==== | + | == Remarks == |
- | === Event Arguments === | + | * //N/A// |
- | ^ Event Arguments ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] |
- | [[#Public Events|Go Back]] | + | |
- | ==== SendingWebRequest ==== | + | |
- | === Event Arguments === | + | |
- | ^ Event Arguments ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.SendingWebRequestEventArgs|SendingWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.SendingWebRequestEventArgs --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** |
- | [[#Public Events|Go Back]] | + | * //N/A// |
- | ==== SentWebRequest ==== | + | == Remarks == |
- | === Event Arguments === | + | * //N/A// |
- | ^ Event Arguments ^ | + | |
- | | [[ThinkGeo.MapSuite.PortableCore.SentWebRequestEventArgs|SentWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.SentWebRequestEventArgs --> | | + | |
- | <!-- ThinkGeo.MapSuite.PortableCore.WorldMapKitLayer --> | + | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] |
- | [[#Public Events|Go Back]] | + | |
- | __NOTOC__ | ||
- | [[Category:MapSuitePortableCore]] | ||
- | [[Category:ThinkGeo.MapSuite.PortableCore]] | ||
- | [[Category:UpdateDocumentation]] | ||