mapscript.webObj

class mapscript.webObj

The WEB object. Has no other existence than as an attribute of a mapObj. Serves as a container for various run-time web application definitions like temporary file paths, template paths, etc.

Attributes

browseformat

char See BROWSEFORMAT

empty

char See EMPTY

error

char Error handling - see ERROR

extent

rectObj The clipping extent - see EXTENT

footer

char Path to footer document - see FOOTER

header

char Path to header document - see HEADER

imagepath

char Filesystem path to temporary image location - see IMAGEPATH

imageurl

char URL to temporary image location - see IMAGEURL

legendformat

char See LEGENDFORMAT

log

char TODO - deprecated - see LOG

map

mapObj immutable Reference to parent mapObj

maxscaledenom

double Minimum map scale - see MAXSCALEDENOM

maxtemplate

char See MAXTEMPLATE

metadata

hashTableObj immutable Metadata hash table - see METADATA

minscaledenom

double Maximum map scale - see MINSCALEDENOM

mintemplate

char See MINTEMPLATE

queryformat

char See QUERYFORMAT /* what format is the query to be returned, given as a MIME type

template

char Path to template document - see TEMPLATE

temppath

char See TEMPPATH

thisown

The membership flag

validation

hashTableObj immutable See VALIDATION

Methods

__init__()[source]

Instances of webObj are always are always embedded inside the mapObj. Has no other existence than as an attribute of a mapObj. Serves as a container for various run-time web application definitions like temporary file paths, template paths, etc.

convertToString() char[source]

Output the WEB object as a Mapfile string. Provides the inverse option for webObj.updateFromString().

updateFromString(snippet: char) int[source]

Update a webObj from a string snippet. Returns MS_SUCCESS or MS_FAILURE