Package mapproxy :: Package wms :: Module request :: Class WMSMapRequestParams
[hide private]
[frames] | no frames]

Class WMSMapRequestParams

source code

                object --+    
                         |    
core.request.RequestParams --+
                             |
                            WMSMapRequestParams
Known Subclasses:

This class represents key-value parameters for WMS map requests.

All values can be accessed as a property. Some properties return processed values. size returns a tuple of the width and height, layers returns an iterator of all layers, etc.

Instance Methods [hide private]
 
__repr__(self)
repr(x)
source code

Inherited from core.request.RequestParams: __contains__, __delitem__, __getattr__, __getitem__, __init__, __setitem__, __str__, copy, get, iteritems, set, with_defaults

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__

Class Variables [hide private]

Inherited from core.request.RequestParams: params

Properties [hide private]
  layers
List with all layer names.
  bbox
bbox as a tuple (minx, miny, maxx, maxy).
  size
Size of the request in pixel as a tuple (width, height), or None if one is missing.
  srs
  transparent
True if transparent is set to true, otherwise False.
  bgcolor
The background color in PIL format (#rrggbb).
  format
The requested format as string (w/o any 'image/', 'text/', etc prefixes)
  format_mime_type

Inherited from core.request.RequestParams: query_string

Inherited from object: __class__

Method Details [hide private]

__repr__(self)
(Representation operator)

source code 
repr(x)
Overrides: object.__repr__
(inherited documentation)

Property Details [hide private]

layers

List with all layer names.
Get Method:
unreachable.layers(self) - List with all layer names.

bbox

bbox as a tuple (minx, miny, maxx, maxy).
Get Method:
unreachable._get_bbox(self) - bbox as a tuple (minx, miny, maxx, maxy).
Set Method:
unreachable._set_bbox(self, value)

size

Size of the request in pixel as a tuple (width, height), or None if one is missing.
Get Method:
unreachable._get_size(self) - Size of the request in pixel as a tuple (width, height), or None if one is missing.
Set Method:
unreachable._set_size(self, value)

srs

Get Method:
unreachable._get_srs(self)
Set Method:
unreachable._set_srs(self, srs)

transparent

True if transparent is set to true, otherwise False.
Get Method:
unreachable.transparent(self) - True if transparent is set to true, otherwise False.

bgcolor

The background color in PIL format (#rrggbb). Defaults to '#ffffff'.
Get Method:
unreachable.bgcolor(self) - The background color in PIL format (#rrggbb).

format

The requested format as string (w/o any 'image/', 'text/', etc prefixes)
Get Method:
unreachable.format(self) - The requested format as string (w/o any 'image/', 'text/', etc prefixes)

format_mime_type

Get Method:
unreachable.format_mime_type(self)