thinkgeo.mapsuite.portablecore.wmsrasterlayer
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.wmsrasterlayer [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.WmsRasterLayer ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | Represents an object that encapsulates a Web Map Service (WMS) layer. | ||
| - | === Remarks === | ||
| - | A Web Map Service (WMS) produces maps of spatially referenced data dynamically from geographic information. This International Standard defines a "map" to be a portrayal of geographic information as a digital image file suitable for display on a computer screen. A map is not the data itself. WMS-produced maps are generally rendered in a pictorial format such as PNG, GIF or JPEG, or occasionally as vector-based graphical elements in Scalable Vector NativeGraphics (SVG) or Web Computer NativeGraphics Metafile (WebCGM) formats. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.PortableCore.Layer]] | ||
| - | ***[[ThinkGeo.MapSuite.PortableCore.RasterLayer]] | ||
| - | ****[[ThinkGeo.MapSuite.PortableCore.WmsRasterLayer]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#WmsRasterLayer()|WmsRasterLayer]] | | | This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#WmsRasterLayer(Uri)|WmsRasterLayer]] | Uri | | This is the constructor the for the class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#WmsRasterLayer(Uri, GeoWebProxy)|WmsRasterLayer]] | Uri, [[ThinkGeo.MapSuite.PortableCore.GeoWebProxy|GeoWebProxy]] | | This is the constructor the for the class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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}}[[#GetFeatureInfo(ScreenPointF)|GetFeatureInfo]] | [[ThinkGeo.MapSuite.PortableCore.ScreenPointF|ScreenPointF]] | | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeatureInfo(ScreenPointF, String, Int32)|GetFeatureInfo]] | [[ThinkGeo.MapSuite.PortableCore.ScreenPointF|ScreenPointF]], String, Int32 | | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeatureInfo(ScreenPointF, String)|GetFeatureInfo]] | [[ThinkGeo.MapSuite.PortableCore.ScreenPointF|ScreenPointF]], String | | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetFeatureInfo(ScreenPointF, Int32)|GetFeatureInfo]] | [[ThinkGeo.MapSuite.PortableCore.ScreenPointF|ScreenPointF]], Int32 | | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHorizontalResolution()|GetHorizontalResolution]] | | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This method returns the horizontal resolution of the image. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetProjectionText()|GetProjectionText]] | | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This method returns the projection parameters of the current layer. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetRequestUrl(RectangleShape, Int32, Int32)|GetRequestUrl]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], Int32, Int32 | | Get the request URL from the client to the WMS. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetServerCapabilitiesXml()|GetServerCapabilitiesXml]] | | | This API gets the GetCapabilites document of the service. | | ||
| - | | {{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}}[[#GetServerFeatureInfoFormats()|GetServerFeatureInfoFormats]] | | | This API gets the WMS server FeatureInfo formats of the service. | | ||
| - | | {{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}}[[#GetVerticalResolution()|GetVerticalResolution]] | | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This method returns the vertical resolution of the image. | | ||
| - | | {{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(RectangleShape, TimeSpan)|RequestDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], TimeSpan | [[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(RectangleShape)|RequestDrawing]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing()|RequestDrawing]] | | [[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(IEnumerable<RectangleShape>)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]> | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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) | | | ||
| - | | {{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) | | | ||
| - | | {{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]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetRequestUrlCore(RectangleShape, Int32, Int32)|GetRequestUrlCore]] | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]], Int32, Int32 | | Get the request URL from the client to the WMS. | | ||
| - | | {{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}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ActiveLayerNames|ActiveLayerNames]] | Collection<String> | | This property represents the available layers that can be requested from the client and shown on the map. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ActiveStyleNames|ActiveStyleNames]] | Collection<String> | | This property represents the available styles that can be requested from the client and shown on the map. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AxisOrder|AxisOrder]] | [[ThinkGeo.MapSuite.PortableCore.WmsAxisOrder|WmsAxisOrder]] | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BlueTranslation|BlueTranslation]] | Single | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the amount of blue to apply to the image. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CapabilitesCacheTimeOut|CapabilitesCacheTimeOut]] | TimeSpan | | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Credentials|Credentials]] | ICredentials | | This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Crs|Crs]] | String | | This property gets or sets the projected or geographic coordinate reference system to be used. | | ||
| - | | {{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}}[[#Exceptions|Exceptions]] | String | | This property indicates the format in which the client wishes to be notified of service exceptions. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#GreenTranslation|GreenTranslation]] | Single | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the amount of green to apply to the image. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#HasBoundingBox|HasBoundingBox]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | This property checks to see if 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}}[[#HasProjectionText|HasProjectionText]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property returns true if the RasterLayer contains projection parameters and false if it does not contain any projection parameters. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ImageSource|ImageSource]] | [[ThinkGeo.MapSuite.PortableCore.RasterSource|RasterSource]] | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the ImageSource used by the RasterLayer. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsGrayscale|IsGrayscale]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets if the image should be converted to grayscale. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsNegative|IsNegative]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | 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}}[[#IsTransparent|IsTransparent]] | Boolean | | This property gets or sets whether the response map image's background color is transparent or 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}}[[#KeyColors|KeyColors]] | Collection<[[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]]> | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#LowerThreshold|LowerThreshold]] | Double | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the lower threshold in the scale at which to display the image. | | ||
| - | | {{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}}[[#OutputFormat|OutputFormat]] | String | | This property gets or sets the desired output format for the map requested from the WMS. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Parameters|Parameters]] | Dictionary<String,String> | | This property specifies a dictionary used to update the request sent from the client to the WMS server. | | ||
| - | | {{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}}[[#RedTranslation|RedTranslation]] | Single | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the amount of red to apply to the image. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#RequestDrawingInterval|RequestDrawingInterval]] | TimeSpan | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{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 | [[ThinkGeo.MapSuite.PortableCore.RasterLayer|RasterLayer]] | This property gets and sets the upper threshold in the scale at which to display the image. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Uri|Uri]] | Uri | | This property specifies the URI of the WMS server. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOpenCore|IsOpenCore]] | Boolean | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]](overriden) | | | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingAttribution|DrawingAttribution]] | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]] | | | ||
| - | | {{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 ===== | ||
| - | ==== WmsRasterLayer() ==== | ||
| - | This is the constructor the for the class. If you use this constructor, then you need to set the required properties manually. | ||
| - | === Overloads === | ||
| - | This is the default constructor. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== WmsRasterLayer(Uri) ==== | ||
| - | This is the constructor the for the class. | ||
| - | === Remarks === | ||
| - | This constructor initializes a new layer, then downloads and parses the service description. In an ASP.NET application, the service description is automatically cached for 24 hours when it is not specified. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | uri | Uri<!-- System.Uri --> | URI of the WMS server. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== WmsRasterLayer(Uri, GeoWebProxy) ==== | ||
| - | This is the constructor the for the class. | ||
| - | === Remarks === | ||
| - | This constructor initializes a new layer, then downloads and parses the service description. In an ASP.NET application, the service description is automatically cached for 24 hours when it is not specified. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | uri | Uri<!-- System.Uri --> | URI of the WMS server. | | ||
| - | | proxy | [[ThinkGeo.MapSuite.PortableCore.GeoWebProxy|GeoWebProxy]]<!-- ThinkGeo.MapSuite.PortableCore.GeoWebProxy --> | Proxy to use for the current WMS layer. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== CloneDeep() ==== | ||
| - | 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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. | ||
| - | |||
| - | 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 Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | This parameter is the canvas object or a GeoImage to draw on. | | ||
| - | | 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 --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | This method returns the bounding box of the Layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetFeatureInfo(ScreenPointF) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Dictionary<String,Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]>><!-- System.Collections.Generic.Dictionary{System.String,System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature}} --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | screenPointF | [[ThinkGeo.MapSuite.PortableCore.ScreenPointF|ScreenPointF]]<!-- ThinkGeo.MapSuite.PortableCore.ScreenPointF --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetFeatureInfo(ScreenPointF, String, Int32) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Dictionary<String,Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]>><!-- System.Collections.Generic.Dictionary{System.String,System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature}} --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | screenPointF | [[ThinkGeo.MapSuite.PortableCore.ScreenPointF|ScreenPointF]]<!-- ThinkGeo.MapSuite.PortableCore.ScreenPointF --> | | | ||
| - | | infoFormat | String<!-- System.String --> | | | ||
| - | | maxFeatures | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetFeatureInfo(ScreenPointF, String) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Dictionary<String,Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]>><!-- System.Collections.Generic.Dictionary{System.String,System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature}} --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | screenPointF | [[ThinkGeo.MapSuite.PortableCore.ScreenPointF|ScreenPointF]]<!-- ThinkGeo.MapSuite.PortableCore.ScreenPointF --> | | | ||
| - | | infoFormat | String<!-- System.String --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetFeatureInfo(ScreenPointF, Int32) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Dictionary<String,Collection<[[ThinkGeo.MapSuite.PortableCore.Feature|Feature]]>><!-- System.Collections.Generic.Dictionary{System.String,System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.Feature}} --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | screenPointF | [[ThinkGeo.MapSuite.PortableCore.ScreenPointF|ScreenPointF]]<!-- ThinkGeo.MapSuite.PortableCore.ScreenPointF --> | | | ||
| - | | maxFeatures | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHorizontalResolution() ==== | ||
| - | This method returns the horizontal resolution of the image. | ||
| - | === Remarks === | ||
| - | This method returns the horizontal resolution of the image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Single<!-- System.Single --> | This method returns the horizontal resolution of the image. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetProjectionText() ==== | ||
| - | This method returns the projection parameters of the current layer. | ||
| - | === Remarks === | ||
| - | This method returns the projection parameters of the current layer. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | This method returns the projection parameters of the current layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetRequestUrl(RectangleShape, Int32, Int32) ==== | ||
| - | Get the request URL from the client to the WMS. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | The request URL from the client to the WMS. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | worldExtent | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | ||
| - | | 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.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetServerCapabilitiesXml() ==== | ||
| - | This API gets the GetCapabilites document of the service. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | This API returns the GetCapabilites document of the service. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetServerCrss() ==== | ||
| - | 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetServerExceptionFormats() ==== | ||
| - | This method returns the exception format at the server side. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This method returns the exception format at the server side. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetServerFeatureInfoFormats() ==== | ||
| - | This API gets the WMS server FeatureInfo formats of the service. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | This API returns the FeatureInfo formats supported on the server-side. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetServerLayerNames() ==== | ||
| - | 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetServerOutputFormats() ==== | ||
| - | 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetServerStyleNames() ==== | ||
| - | 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetServiceVersion() ==== | ||
| - | This API gets the WMS server version of the service. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | Returning a string reflecting the version of the service in WMS. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetVerticalResolution() ==== | ||
| - | This method returns the vertical resolution of the image. | ||
| - | === Remarks === | ||
| - | This method returns the vertical resolution of the image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Single<!-- System.Single --> | This method returns the vertical resolution of the image. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Open() ==== | ||
| - | 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. | ||
| - | |||
| - | 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 Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(RectangleShape, TimeSpan) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentToRefresh | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(TimeSpan) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(RectangleShape) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentToRefresh | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(IEnumerable<RectangleShape>, TimeSpan) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== RequestDrawing(IEnumerable<RectangleShape>) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | extentsToRefresh | IEnumerable<[[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.PortableCore.RectangleShape} --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== CloneDeepCore() ==== | ||
| - | Create a copy of Layer using the deep clone process. The default implemenation uses serialization. | ||
| - | === Remarks === | ||
| - | The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.Layer|Layer]]<!-- ThinkGeo.MapSuite.PortableCore.Layer --> | A cloned Layer. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== CloseCore() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawAttributionCore(GeoCanvas, String) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | | | ||
| - | | attribution | String<!-- System.String --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawCore(GeoCanvas, Collection<SimpleCandidate>) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | | | ||
| - | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.PortableCore.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.SimpleCandidate} --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | The target canvas to draw the layer. | | ||
| - | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawExceptionCore(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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.PortableCore.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.PortableCore.GeoCanvas --> | The target canvas to draw the layer. | | ||
| - | | e | Exception<!-- System.Exception --> | The exception thrown when layer.Draw(). | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetBoundingBoxCore() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetRequestUrlCore(RectangleShape, Int32, Int32) ==== | ||
| - | Get the request URL from the client to the WMS. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | The request URL from the client to the WMS. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | worldExtent | [[ThinkGeo.MapSuite.PortableCore.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.PortableCore.RectangleShape --> | | | ||
| - | | 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.WmsRasterLayer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawingAttribution(DrawingAttributionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | args | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawingException(DrawingExceptionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawnAttribution(DrawnAttributionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | args | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnDrawnException(DrawnExceptionLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnRequestedDrawing(RequestedDrawingLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | eventArgs | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OnRequestingDrawing(RequestingDrawingLayerEventArgs) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | eventArgs | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== OpenCore() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== ActiveLayerNames ==== | ||
| - | This property represents the available layers that can be requested from the client and shown on the map. | ||
| - | === Remarks === | ||
| - | When requesting a map, a client may specify the layers to be shown on the map. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ActiveStyleNames ==== | ||
| - | This property represents the available styles that can be requested from the client and shown on the map. | ||
| - | === Remarks === | ||
| - | When requesting a map, a client may specify the styles to be shown on the map. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Attribution ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== AxisOrder ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.WmsAxisOrder|WmsAxisOrder]]<!-- ThinkGeo.MapSuite.PortableCore.WmsAxisOrder --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== BlueTranslation ==== | ||
| - | This property gets and sets the amount of blue to apply to the image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== CapabilitesCacheTimeOut ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | TimeSpan<!-- System.TimeSpan --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Credentials ==== | ||
| - | This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | ICredentials<!-- System.Net.ICredentials --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Crs ==== | ||
| - | This property gets or sets the projected or geographic coordinate reference system to be used. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== DrawingExceptionMode ==== | ||
| - | 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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== DrawingTime ==== | ||
| - | This property gets the last drawing time for the layer. | ||
| - | === Remarks === | ||
| - | 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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Exceptions ==== | ||
| - | This property indicates the format in which the client wishes to be notified of service exceptions. | ||
| - | === Remarks === | ||
| - | Upon receiving a request that is invalid according to the OGC standard, the server shall issue a service exception report. The service report is meant to describe to the client application or its human user the reason(s) that the request is invalid. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== GreenTranslation ==== | ||
| - | This property gets and sets the amount of green to apply to the image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== HasBoundingBox ==== | ||
| - | This property checks to see if 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 override in the WmsRasterLayer sets it to true. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== HasProjectionText ==== | ||
| - | This property returns true if the RasterLayer contains projection parameters and false if it does not contain any projection parameters. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== ImageSource ==== | ||
| - | This property gets and sets the ImageSource used by the RasterLayer. | ||
| - | === Remarks === | ||
| - | The set for this property is protected and only intended to be used by developers who are creating their own ImageSources. This is the main property to set for developers who are creating their own RasterLayer derivatives. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RasterSource|RasterSource]]<!-- ThinkGeo.MapSuite.PortableCore.RasterSource --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsGrayscale ==== | ||
| - | This property gets and sets if the image should be converted to grayscale. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#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.RasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsOpen ==== | ||
| - | This property returns true if the Layer is open and false if it is not. | ||
| - | === Remarks === | ||
| - | This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open. | ||
| - | |||
| - | As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsTransparent ==== | ||
| - | This property gets or sets whether the response map image's background color is transparent or not. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== IsVisible ==== | ||
| - | This property gets and set the visible state of the layer. | ||
| - | === Remarks === | ||
| - | If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== KeyColors ==== | ||
| - | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors. | ||
| - | === Remarks === | ||
| - | It will make these colors transparent when draw image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Collection<[[ThinkGeo.MapSuite.PortableCore.GeoColor|GeoColor]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.PortableCore.GeoColor} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== LowerThreshold ==== | ||
| - | This property gets and sets the lower threshold in the scale at which to display the image. | ||
| - | === Remarks === | ||
| - | Below the lower threshold in scale, the image will not be displayed. This, in conjunction with the UpperThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is double.min. This means the image should always display. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Double<!-- System.Double --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== OutputFormat ==== | ||
| - | This property gets or sets the desired output format for the map requested from the WMS. | ||
| - | === Remarks === | ||
| - | When requesting a map, a client may specify the output format in which to show the map. Format are specified as MIME types such as "image/gif" or "image/png". | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Parameters ==== | ||
| - | This property specifies a dictionary used to update the request sent from the client to the WMS server. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#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.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RedTranslation ==== | ||
| - | This property gets and sets the amount of red to apply to the image. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Single<!-- System.Single --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== RequestDrawingInterval ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | TimeSpan<!-- System.TimeSpan --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TimeoutInSecond ==== | ||
| - | This property specifies the timeout of the web request in seconds. The default timeout value is 20 seconds. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== UpperThreshold ==== | ||
| - | This property gets and sets the upper threshold in the scale at which to display the image. | ||
| - | === Remarks === | ||
| - | Above the upper threshold in scale, the image will not be displayed. This, in conjunction with the LowerThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is double.min. This means the image should always display. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Double<!-- System.Double --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.RasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Uri ==== | ||
| - | This property specifies the URI of the WMS server. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Uri<!-- System.Uri --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ==== IsOpenCore ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer(overriden) --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | ==== DrawingAttribution ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingAttributionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawingException ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingExceptionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawingProgressChanged ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawingProgressChangedEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawnAttribution ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnAttributionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== DrawnException ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.DrawnExceptionLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== RequestedDrawing ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestedDrawingLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== RequestingDrawing ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.RequestingDrawingLayerEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.Layer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== SendingWebRequest ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.SendingWebRequestEventArgs|SendingWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.SendingWebRequestEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | ==== SentWebRequest ==== | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.SentWebRequestEventArgs|SentWebRequestEventArgs]]<!-- ThinkGeo.MapSuite.PortableCore.SentWebRequestEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.WmsRasterLayer --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | |||
| - | __NOTOC__ | ||
| - | [[Category:MapSuitePortableCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.portablecore.wmsrasterlayer.1440040133.txt.gz ยท Last modified: 2015/09/21 08:21 (external edit)
