ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin

This class is the base class for all types of WMS Plug-ins. The WmsLayerPlugin class is where all other types of WMS Plug-ins are inherited from. It provides the base set of functionality. As it is abstract, there are a number of methods you need to implement. The first one is GetMapConfigurationCore. In this method, you are responsible for generating a MapConfiguration which includes layers collection and TileCache object you will use. The other two required methods are GetProjectionCore and GetBoundingBoxCore. These get projection string and the BoundingBox for your WMS Plug-in. Another required method is GetNameCore which returns the layer name which will used in the GetMap WMS operation.

• System.Object
  • ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin

WmsLayerPlugin()

• This is the default constructor for the WmsLayerPlugin class.

• This is the default constructor for the WmsLayerPlugin class.

GetTitle()

• This method returns the human-readable name of the WmsLayerPlugin.

• This method is the concrete wrapper for the virtual method GetTitleCore. It returns the human-readable name of the WmsLayerPlugin.

• Type:String
• Description:This method returns the human-readable name of the WmsLayerPlugin.

GetName()

• This method returns a single word used for machine-to-machine communication.

• This method is the concrete wrapper for the abstract method GetNameCore. It returns returns a single word used for machine-to-machine communication.

• Type:String
• Description:This method returns a single word used for machine-to-machine communication.

GetProjections()

• This method returns the projection string collection that are supported.

• This method returns the projection string collection that are supported.

• Type:Collection<String>
• Description:This method returns the projection string collection that are supported.

GetStyles()

• This method you need to return the styels that are supported.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetStyles.28.29

• Type:Collection<WmsLayerStyle>
• Description:This method you need to return the styels that are supported.

GetGeographyUnit(String)

• This method returns the exact map unit (dependent on the crs) in order to support multiple projections.

• This method returns the exact map unit (dependent on the crs) in order to support multiple projections.

• Type:GeographyUnit
• Description:This method returns the exact map unit (dependent on the crs) in order to support multiple projections.

• crs
  • Type:String
  • Description:The user gets the exact map unit (dependent on the crs) in order to support multiple projections.

GetMapConfiguration(String,String)

• This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMapConfiguration.28String.2C_String.29

• Type:MapConfiguration
• Description:Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style.

• style
  • Type:String
  • Description:The style parameter string.

• crs
  • Type:String
  • Description:The projectin parameter string.

GetBoundingBox(String)

• This method returns the bounding box of the Layer.

• This method returns the bounding box of the Layer.

• Type:RectangleShape
• Description:This method returns the bounding box of the Layer.

• crs
  • Type:String
  • Description:User gets the exact bounding box depend on crs in order to support multiple projections.

GetCapabilities()

• This method gets the general information about the plug-in itself.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetCapabilities.28.29

• Type:String
• Description:This method gets the general information about the plug-in itself.

GetMap(GetMapRequest,MapConfiguration,HttpContext)

• Produce a map, which is defined as either a pictorial image or a set of graphical elements.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMap.28GetMapRequest.2C_MapConfiguration.2C_HttpContext.29

• Type:Bitmap
• Description:N/A

• getMapRequest
  • Type:GetMapRequest
  • Description:The RequestInfo object corresponding to the QueryString from the client's request.

• cachedMapConfiguration
  • Type:MapConfiguration
  • Description:MapConfiguration object from HttpContext.Application.

• context
  • Type:HttpContext
  • Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.

GetFeatureInfo(GetFeatureInfoRequest,MapConfiguration,HttpContext)

• This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.

• This abstract method is called from the concrete public method GetFeatureInfo. The canonical use case for GetFeatureInfo is that a user sees the response of a GetMap request and chooses a point on that map for which to obtain more information. The basic operation provides the ability for a client to specify which pixel is being asked about, which layer(s) should be investigated, and what format the information should be returned in.

• Type:String
• Description:This method returns feature information depending on the request from the client.

• getFeatureInfoRequest
  • Type:GetFeatureInfoRequest
  • Description:The RequestInfo object corresponding to the QueryString from the client's request.

• cachedMapConfiguration
  • Type:MapConfiguration
  • Description:MapConfiguration object from HttpContext.Application.

• context
  • Type:HttpContext
  • Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.

ToString()

• N/A

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#ToString.28.29

• Type:String
• Description:N/A

Equals(Object)

• N/A

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#Equals.28Object.29

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

• N/A

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetHashCode.28.29

• Type:Int32
• Description:N/A

GetType()

• N/A

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetType.28.29

• Type:Type
• Description:N/A

GetTitleCore()

• This method returns the human-readable name of the WmsLayerPlugin.

• This method is called from the concrete public method GetTitle. This method returns the human-readable name of the WmsLayerPlugin.

• Type:String
• Description:This method returns the human-readable name of the WmsLayerPlugin.

GetNameCore()

• This method returns a single word used for machine-to-machine communication.

• This method is called from the concrete public method GetName. It returns a single word used for machine-to-machine communication.

• Type:String
• Description:This method returns a single word used for machine-to-machine communication.

GetProjectionsCore()

• This method returns the projection string collection that are supported.

• This method returns the projection string collection that are supported.

• Type:Collection<String>
• Description:This method returns the projection string collection that are supported.

GetStylesCore()

• This method you need to return the styels that are supported.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetStylesCore.28.29

• Type:Collection<WmsLayerStyle>
• Description:This method you need to return the styels that are supported.

GetGeographyUnitCore(String)

• This method returns the exact map unit (dependent on the crs) in order to support multiple projections.

• This method returns the exact map unit (dependent on the crs) in order to support multiple projections.

• Type:GeographyUnit
• Description:This method returns the exact map unit (dependent on the crs) in order to support multiple projections.

• crs
  • Type:String
  • Description:The user gets the exact map unit (dependent on the crs) in order to support multiple projections.

GetMapConfigurationCore(String,String)

• This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMapConfigurationCore.28String.2C_String.29

• Type:MapConfiguration
• Description:Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style.

• style
  • Type:String
  • Description:The style parameter string.

• crs
  • Type:String
  • Description:The projectin parameter string.

GetBoundingBoxCore(String)

• This method returns the bounding box of the Layer.

• This method returns the bounding box of the Layer.

• Type:RectangleShape
• Description:This method returns the bounding box of the Layer.

• crs
  • Type:String
  • Description:User gets the exact bounding box depend on crs in order to support multiple projections.

GetCapabilitiesCore()

• This method gets the general information about the plug-in itself.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetCapabilitiesCore.28.29

• Type:String
• Description:This method gets the general information about the plug-in itself.

GetMapCore(GetMapRequest,MapConfiguration,HttpContext)

• Produce a map, which is defined as either a pictorial image or a set of graphical elements.

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMapCore.28GetMapRequest.2C_MapConfiguration.2C_HttpContext.29

• Type:Bitmap
• Description:N/A

• getMapRequest
  • Type:GetMapRequest
  • Description:The RequestInfo object corresponding to the QueryString from the client's request.

• cachedMapConfiguration
  • Type:MapConfiguration
  • Description:MapConfiguration object from HttpContext.Application.

• context
  • Type:HttpContext
  • Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.

GetFeatureInfoCore(GetFeatureInfoRequest,MapConfiguration,HttpContext)

• This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.

• This abstract method is called from the concrete public method GetFeatureInfo. The canonical use case for GetFeatureInfo is that a user sees the response of a GetMap request and chooses a point on that map for which to obtain more information. The basic operation provides the ability for a client to specify which pixel is being asked about, which layer(s) should be investigated, and what format the information should be returned in.

• Type:String
• Description:This method returns feature information depending on the request from the client.

• getFeatureInfoRequest
  • Type:GetFeatureInfoRequest
  • Description:The RequestInfo object corresponding to the QueryString from the client's request.

• cachedMapConfiguration
  • Type:MapConfiguration
  • Description:MapConfiguration object from HttpContext.Application.

• context
  • Type:HttpContext
  • Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.

Finalize()

• N/A

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#Finalize.28.29

• Type:Void
• Description:N/A

MemberwiseClone()

• N/A

• For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#MemberwiseClone.28.29

• Type:Object
• Description:N/A

WmsQueryMode

This enumeration specifies whether a WmsLayerPlugin support GetFeatureInfo WMS operation or not. If it doesn't support GetFeatureInfo operation, and it will throw an Service Exception XML.

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#WmsQueryMode

• Type:WmsQueryMode

JpegQuality

Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#JpegQuality

• Type:Int16

BrowerCacheExpiration

Represents the number of hours before the browser cache expires.

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#BrowerCacheExpiration

• Type:TimeSpan

RRQ=

N/A

N/A

• Type:String