Luciad.Formats.Wms.WmsDataSource Class Reference

Data source representation for a WMS, with one or more layers. More...

Inheritance diagram for Luciad.Formats.Wms.WmsDataSource:

Classes
class	Builder
	A builder to create WmsDataSource instances. More...
class	Layer
	Represents a WMS layer with an optional style. More...

Public Member Functions
void	Dispose ()

Static Public Member Functions
static Luciad.Formats.Wms.WmsDataSource.Builder	NewBuilder ()
	Returns the builder class for creation of the WMS data source. More...

Properties
string	Format [get]
	The image format that should be used when decoding the WMS layer. More...
bool	IsTransparent [get]
	Whether the WMS is requested to return an image with a transparent background. More...
System.Collections.Generic.IList< Luciad.Formats.Wms.WmsDataSource.Layer >	Layers [get]
	The list of WMS layers to load. More...
string	StyledLayerDescriptor [get]
	The Styled Layer Descriptor to use or null if not set. More...
string	StyledLayerDescriptorUrl [get]
	The Styled Layer Descriptor URL to use or null if not set. More...
string	Url [get]
	The base URL of the WMS data source. More...

Detailed Description

Data source representation for a WMS, with one or more layers.

The WMS data source requires as a minimum:

• The URL location of the WMS.
• One or more layers.

By default the data source is configured to request images from the WMS server with a transparent background.

Since

2020.2

See also

WmsCapabilities to get the layers' information.

Member Function Documentation

Dispose()

void Luciad.Formats.Wms.WmsDataSource.Dispose ( )

inline

NewBuilder()

static Luciad.Formats.Wms.WmsDataSource.Builder Luciad.Formats.Wms.WmsDataSource.NewBuilder ( )

inlinestatic

Returns the builder class for creation of the WMS data source.

Returns

the builder class for creation of the WMS data source.

Property Documentation

Format

string Luciad.Formats.Wms.WmsDataSource.Format

get

The image format that should be used when decoding the WMS layer.

[get]

Returns the image format that should be used when decoding the WMS layer. A null return value indicates the format should be auto-detected.

IsTransparent

bool Luciad.Formats.Wms.WmsDataSource.IsTransparent

get

Whether the WMS is requested to return an image with a transparent background.

[get]

Returns whether the WMS is requested to return an image with a transparent background.

Layers

System.Collections.Generic.IList<Luciad.Formats.Wms.WmsDataSource.Layer> Luciad.Formats.Wms.WmsDataSource.Layers

get

The list of WMS layers to load.

[get]

Returns the list of WMS layers to load. The layers are ordered from bottom to top.

StyledLayerDescriptor

string Luciad.Formats.Wms.WmsDataSource.StyledLayerDescriptor

get

The Styled Layer Descriptor to use or null if not set.

[get]

Returns the Styled Layer Descriptor to use or null if not set.

StyledLayerDescriptorUrl

string Luciad.Formats.Wms.WmsDataSource.StyledLayerDescriptorUrl

get

The Styled Layer Descriptor URL to use or null if not set.

[get]

Returns the Styled Layer Descriptor URL to use or null if not set.

Url

string Luciad.Formats.Wms.WmsDataSource.Url

get

The base URL of the WMS data source.

[get]

Returns the base URL of the WMS data source.