Represents a layer downloading and displaying the data from the particular WMS Server. More...

Collaboration diagram for WmsLayer:

Public Member Functions
void	Close ()
	Closes the layer. More...

bool	Deserialize (string state)
	Restores the state of the layer from the string. More...

string	get_ErrorMsg (int ErrorCode)
	Gets error message for the specific error code. More...

string	Serialize ()
	Serializes the state of the layer. More...

Properties
string	BaseUrl `[get, set]`
	Gets or sets the base URL of the WMS layer. More...

Extents	BoundingBox `[get, set]`
	Gets or sets the bounding box of the layer (server coordinate system). More...

float	Brightness `[get, set]`
	Gets or sets the brightness of layer (color adjustment to be used during rendering). More...

float	Contrast `[get, set]`
	Gets or sets the contrast of layer (color adjustment to be used during rendering). More...

bool	DoCaching `[get, set]`
	Gets or sets a value indicating whether the data will be cached locally. More...

int	Epsg `[get, set]`
	Gets or sets the EPSG code of the coordinate system to be used to request data from the server. More...

string	Format `[get, set]`
	Gets or sets the format parameter of the request. More...

float	Gamma `[get, set]`
	Gets or sets the gamma of layer (color adjustment to be used during rendering). More...

GeoProjection	GeoProjection `[get]`
	Gets the projection of the layer. More...

float	Hue `[get, set]`
	Gets or sets the hue of layer (color adjustment to be used during rendering). More...

int	Id `[get, set]`
	Gets or sets the unique identifier of the layer. It is used to cache the data locally. More...

bool	IsEmpty `[get]`
	Gets a value indicating whether this instance is initialized (bound to particular server). More...

string	Key `[get, set]`
	Gets or sets a key associated with this instance (any data can be stored in it by applications). More...

int	LastErrorCode `[get]`
	Gets the code of the last error which occurred inside this instance. More...

string	Layers `[get, set]`
	Gets or sets the string with the layers to be requested from server (several comma separated layers are can be specified). More...

Extents	MapExtents `[get]`
	Gets the bounding box for the layer in map coordinates. More...

string	Name `[get, set]`
	Gets or sets the name of the layer. More...

byte	Opacity `[get, set]`
	Gets or sets the opacity of the layer which is used during rendering. More...

float	Saturation `[get, set]`
	Gets or sets the contrast of layer (color adjustment to be used during rendering). More...

string	Styles `[get, set]`
	Gets or sets the styles parameter which will be included in the request. More...

uint	TransparentColor `[get, set]`
	Gets or sets the color which be treated as transparent during rendering. More...

bool	UseCache `[get, set]`
	Gets or sets a value indicating whether data from the local cache will be used. More...

bool	UseTransparentColor `[get, set]`
	Gets or sets a value indicating whether transparent color should be used. More...

tkWmsVersion	Version `[get, set]`
	Gets or sets the version parameter which will be included in the request. More...

Detailed Description

Represents a layer downloading and displaying the data from the particular WMS Server.

New API 4.9.4:: Added in version 4.9.4

Member Function Documentation

◆ Close()

void WmsLayer.Close ( )

Closes the layer.

◆ Deserialize()

bool WmsLayer.Deserialize ( string state )

Restores the state of the layer from the string.

Parameters

state String with the previous state of the layer.

Returns: True on success.

◆ get_ErrorMsg()

string WmsLayer.get_ErrorMsg ( int ErrorCode )

Gets error message for the specific error code.

Parameters

ErrorCode The error code.

Returns: The error message.

◆ Serialize()

string WmsLayer.Serialize ( )

Serializes the state of the layer.

Returns: The string with serialized state.

Property Documentation

◆ BaseUrl

string WmsLayer.BaseUrl

getset

Gets or sets the base URL of the WMS layer.

For example, http://demo.lizardtech.com/lizardtech/iserv/ows. The other parts of the request will be generated dynamically.

◆ BoundingBox

Extents WmsLayer.BoundingBox

getset

Gets or sets the bounding box of the layer (server coordinate system).

◆ Brightness

float WmsLayer.Brightness

getset

Gets or sets the brightness of layer (color adjustment to be used during rendering).

◆ Contrast

float WmsLayer.Contrast

getset

Gets or sets the contrast of layer (color adjustment to be used during rendering).

◆ DoCaching

bool WmsLayer.DoCaching

getset

Gets or sets a value indicating whether the data will be cached locally.

◆ Epsg

int WmsLayer.Epsg

getset

Gets or sets the EPSG code of the coordinate system to be used to request data from the server.

◆ Format

string WmsLayer.Format

getset

Gets or sets the format parameter of the request.

◆ Gamma

float WmsLayer.Gamma

getset

Gets or sets the gamma of layer (color adjustment to be used during rendering).

◆ GeoProjection

GeoProjection WmsLayer.GeoProjection

get

Gets the projection of the layer.

◆ Hue

float WmsLayer.Hue

getset

Gets or sets the hue of layer (color adjustment to be used during rendering).

◆ Id

int WmsLayer.Id

getset

Gets or sets the unique identifier of the layer. It is used to cache the data locally.

◆ IsEmpty

bool WmsLayer.IsEmpty

get

Gets a value indicating whether this instance is initialized (bound to particular server).

◆ Key

string WmsLayer.Key

getset

Gets or sets a key associated with this instance (any data can be stored in it by applications).

◆ LastErrorCode

int WmsLayer.LastErrorCode

get

Gets the code of the last error which occurred inside this instance.

◆ Layers

string WmsLayer.Layers

getset

Gets or sets the string with the layers to be requested from server (several comma separated layers are can be specified).

◆ MapExtents

Extents WmsLayer.MapExtents

get

Gets the bounding box for the layer in map coordinates.

◆ Name

string WmsLayer.Name

getset

Gets or sets the name of the layer.

◆ Opacity

byte WmsLayer.Opacity

getset

Gets or sets the opacity of the layer which is used during rendering.

◆ Saturation

float WmsLayer.Saturation

getset

Gets or sets the contrast of layer (color adjustment to be used during rendering).

◆ Styles

string WmsLayer.Styles

getset

Gets or sets the styles parameter which will be included in the request.

◆ TransparentColor

uint WmsLayer.TransparentColor

getset

Gets or sets the color which be treated as transparent during rendering.

◆ UseCache

bool WmsLayer.UseCache

getset

Gets or sets a value indicating whether data from the local cache will be used.

◆ UseTransparentColor

bool WmsLayer.UseTransparentColor

getset

Gets or sets a value indicating whether transparent color should be used.

◆ Version

tkWmsVersion WmsLayer.Version

getset

Gets or sets the version parameter which will be included in the request.

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Close()

◆ Deserialize()

◆ get_ErrorMsg()

◆ Serialize()

Property Documentation

◆ BaseUrl

◆ BoundingBox

◆ Brightness

◆ Contrast

◆ DoCaching

◆ Epsg

◆ Format

◆ Gamma

◆ GeoProjection

◆ Hue

◆ Id

◆ IsEmpty

◆ Key

◆ LastErrorCode

◆ Layers

◆ MapExtents

◆ Name

◆ Opacity

◆ Saturation

◆ Styles

◆ TransparentColor

◆ UseCache

◆ UseTransparentColor

◆ Version