mapscript.mapObj¶
- class mapscript.mapObj(*args)¶
The MAP object
Overview
The mapObj has the following relationships:
Attributes
cellsize
double Pixel size in map units
config
configObj const immutable TODO Add documentation
configoptions
hashTableObj
immutable A hash table of configuration options from CONFIG keywords in the map - see CONFIGdatapattern
char TODO - Deprecated use VALIDATION .
debug
int See DEBUG
defresolution
double Default resolution - used to calculate the scalefactor, see DEFRESOLUTION
extent
fontset
fontSetObj
immutable See FONTSETheight
int See SIZE
imagecolor
colorObj
Holds the initial image color value - see IMAGECOLORimagetype
char immutable Name of current outputformat
labelcache
labelCacheObj
immutable We need this here so multiple feature processors can access itlayerorder
int Used to modify the order in which the layers are drawn - TODO should be immutable?
legend
mappath
char Path of the mapfile, all paths are relative to this path
maxlayers
int immutable Allocated size of layers[] array
maxsize
int See MAXSIZE
name
char Small identifier for naming etc - see NAME
numlayers
int immutable Number of layers in mapfile
numoutputformats
int immutable Number of output formats available in the map
outputformat
outputFormatObj
immutable See OUTPUTFORMATquerymap
queryMapObj
immutable See QUERYMAPrefcount
int immutable Used for reference counting see RFC24
reference
referenceMapObj
immutable See SCALEBARresolution
double See RESOLUTION
scalebar
scalebarObj
immutable See SCALEBARscaledenom
double The nominal map scale, a value of 25000 means 1:25000 scale - see SCALEDENOM
shapepath
char Where are the shape files located - see SHAPEPATH
sldurl
char URL of SLD document as specified with "&SLD=..." WMS parameter d- currently this reference is used only in mapogcsld.c and has a NULL value outside that context
status
int Is map creation on or off - see STATUS
symbolset
symbolSetObj
immutable See SYMBOLSETtemplatepattern
char TODO - Deprecated use VALIDATION .
thisown
The membership flag
units
enum MS_UNITS Units of the projection - see UNITS
web
width
int See SIZE
Methods
- OWSDispatch(req: OWSRequest) int [broncode]¶
Processes and executes the passed OpenGIS Web Services request on the map. Returns
MS_DONE
(2) if there is no valid OWS request in the req object,MS_SUCCESS
(0) if an OWS request was successfully processed andMS_FAILURE
(1) if an OWS request was not successfully processed. OWS requests include WMS, WFS, WCS and SOS requests supported by MapServer. Results of a dispatched request are written to stdout and can be captured using the msIO services (i.e.mapscript.msIO_installStdoutToBuffer()
andmapscript.msIO_getStdoutBufferString()
- __init__(*args)[broncode]¶
Create a new instance of
mapObj
. Note that the filename is optional.
- appendOutputFormat(format: outputFormatObj) int [broncode]¶
Attach format to the map’s output format list. Returns the updated number of output formats.
- applyConfigOptions() void [broncode]¶
Apply the defined configuration options set by setConfigOption()
- applyDefaultSubstitutions() void [broncode]¶
Apply any default values defined in a VALIDATION block used for runtime substitutions
- applySLD(sld: char) int [broncode]¶
Parse the SLD XML string sldxml and apply to map layers. Returns
MS_SUCCESS
orMS_FAILURE
- applySLDURL(sld: char) int [broncode]¶
Fetch SLD XML from the URL sldurl and apply to map layers. Returns
MS_SUCCESS
orMS_FAILURE
- applySubstitutions(names: char) void [broncode]¶
Pass in runtime substitution keys and values and apply them to the map. Note - this method is currently enabled for Python only. Typemaps are needed for other MapScript languages.
- clone() mapObj [broncode]¶
Return an independent copy of the map, less any caches.
Notitie
In the Java & PHP modules this method is named
cloneMap
.
- convertToString() char [broncode]¶
Saves the object to a string. Provides the inverse option for updateFromString.
- draw() imageObj [broncode]¶
Draw the map, processing layers according to their defined order and status. Return an
imageObj
.
- drawLabelCache(image: imageObj) int [broncode]¶
Draw map’s label cache on image. Returns
MS_SUCCESS
orMS_FAILURE
.
- drawLegend(scale_independent: int = 0) imageObj [broncode]¶
Draw map legend, returning an
imageObj
.
- drawQuery() imageObj [broncode]¶
Draw query map, returning an
imageObj
.
- drawReferenceMap() imageObj [broncode]¶
Draw reference map, returning an
imageObj
.
- drawScalebar() imageObj [broncode]¶
Draw scale bar, returning an
imageObj
.
- embedLegend(image: imageObj) int [broncode]¶
Embed map’s legend in image. Returns
MS_SUCCESS
orMS_FAILURE
.
- embedScalebar(image: imageObj) int [broncode]¶
Embed map’s legend in image. Returns
MS_SUCCESS
orMS_FAILURE
.
- freeQuery(qlayer: int = -1) void [broncode]¶
Clear layer query result caches. Default is -1, or all layers.
- generateSLD(sldVersion: char = None) char [broncode]¶
Return SLD XML as a string for map layers that have STATUS on.
- getConfigOption(key: char) char [broncode]¶
Fetches the value of the requested configuration key if set. Returns NULL if the key is not set.
- getLayer()[broncode]¶
Returns a reference to the layer at index i.
- getLayerByName()[broncode]¶
Returns a reference to the named layer.
- getLayerOrder() PyObject [broncode]¶
Python MapScript only - returns the map layer order as a native sequence
- getLayersDrawingOrder() intarray [broncode]¶
Returns an array of layer indexes in drawing order. Note Unless the proper typemap is implemented for the module’s language a user is more likely to get back an unusable SWIG pointer to the integer array.
- getNumSymbols() int [broncode]¶
Return the number of symbols in map
- getOutputFormat(i: int) outputFormatObj [broncode]¶
Returns the output format at the specified i index from the output formats array or null if i is beyond the array bounds. The number of outpuFormats can be retrieved by calling
mapObj.getNumoutputformats()
.
- getOutputFormatByName(name: char const) outputFormatObj [broncode]¶
Return the output format corresponding to driver name imagetype or to format name imagetype. This works exactly the same as the IMAGETYPE directive in a mapfile, is case insensitive and allows an output format to be found either by driver (like ‘AGG/PNG’) or name (like ‘png’).
- getProjection() char [broncode]¶
Returns the PROJ definition of the map’s projection.
- getRotation() double [broncode]¶
Returns the map rotation angle.
- getSize() PyObject [broncode]¶
Python MapScript only - gets the map size as a tuple
- getSymbolByName(name: char) int [broncode]¶
Return the index of the named symbol in the map’s symbolset.
Notitie
This method is poorly named and too indirect. It is preferable to use the getSymbolByName method of
symbolSetObj
, which really does return asymbolObj
reference, or use the index method of symbolSetObj to get a symbol’s index number.
- get_height()[broncode]¶
Python MapScript only Return the map height from the map size
- get_width()[broncode]¶
Python MapScript only Return the map width from the map size
- insertLayer()[broncode]¶
Insert a copy of layer into the map at index. The default value of index is -1, which means the last possible index. Returns the index of the new layer, or -1 in the case of a failure.
- loadMapContext(szFileName: char, useUniqueNames: int = 0) int [broncode]¶
Load an OGC map context file to define extents and layers of a map Returns
MS_SUCCESS
orMS_FAILURE
- loadOWSParameters(*args) int [broncode]¶
Load OWS request parameters (BBOX, LAYERS, &c.) into map. Returns
MS_SUCCESS
orMS_FAILURE
- loadQuery(filename: char) int [broncode]¶
Load a saved query. Returns
MS_SUCCESS
orMS_FAILURE
- moveLayerDown(layerindex: int) int [broncode]¶
Move the layer at layerindex down in the drawing order array, meaning that it is drawn later. Returns
MS_SUCCESS
orMS_FAILURE
- moveLayerUp(layerindex: int) int [broncode]¶
Move the layer at layerindex up in the drawing order array, meaning that it is drawn earlier. Returns
MS_SUCCESS
orMS_FAILURE
- offsetExtent(x: double, y: double) int [broncode]¶
Offset the map extent based on the given distances in map coordinates. Returns
MS_SUCCESS
orMS_FAILURE
.
- pixelToGeoref(pixPosX: double, pixPosY: double, geoPos: pointObj) void [broncode]¶
TODO
- prepareImage() imageObj [broncode]¶
Returns an
imageObj
initialized to map extents and outputformat.
- prepareQuery() void [broncode]¶
TODO this function only calculates the scale or am I missing something?
- processLegendTemplate(names: char, values: char, numentries: int) char [broncode]¶
Process MapServer legend template and return HTML. Note none of the three template processing methods will be usable unless the proper typemaps are implemented in the module for the target language.Currently the typemaps are not implemented.
- processQueryTemplate(names: char, values: char, numentries: int) char [broncode]¶
Process MapServer query template and return HTML. Note none of the three template processing methods will be usable unless the proper typemaps are implemented in the module for the target language.Currently the typemaps are not implemented.
- processTemplate(bGenerateImages: int, names: char, values: char, numentries: int) char [broncode]¶
Process MapServer template and return HTML. Note none of the three template processing methods will be usable unless the proper typemaps are implemented in the module for the target language.Currently the typemaps are not implemented.
- queryByFeatures(slayer: int) int [broncode]¶
Query map layers, result sets contain features that intersect or are contained within the features in the result set of the
MS_LAYER_POLYGON
type layer at layer index slayer. ReturnsMS_SUCCESS
orMS_FAILURE
.
- queryByFilter(string: char) int [broncode]¶
Query map layers using the filter string. Returns
MS_SUCCESS
orMS_FAILURE
.
- queryByPoint(point: pointObj, mode: int, buffer: double) int [broncode]¶
Query map layers, result sets contain one or more features, depending on mode, that intersect point within a tolerance buffer. Returns
MS_SUCCESS
orMS_FAILURE
.
- queryByRect(rect: rectObj) int [broncode]¶
Query map layers, result sets contain features that intersect or are contained within the features in the result set of the
MS_LAYER_POLYGON
type layer at layer index slayer. ReturnsMS_SUCCESS
orMS_FAILURE
.
- queryByShape(shape: shapeObj) int [broncode]¶
Query layer based on a single shape, the shape has to be a polygon at this point. Returns
MS_SUCCESS
if shapes were found orMS_FAILURE
if nothing was found or if some other error happened
- removeLayer(index: int) layerObj [broncode]¶
Remove the layer at index. Returns the
layerObj
.
- removeOutputFormat(name: char const) int [broncode]¶
Removes the format named name from the map’s output format list. Returns
MS_SUCCESS
orMS_FAILURE
- save(filename: char) int [broncode]¶
Save map to disk as a new map file. Returns
MS_SUCCESS
orMS_FAILURE
- saveMapContext(szFileName: char) int [broncode]¶
Save map definition to disk as OGC-compliant XML. Returns
MS_SUCCESS
orMS_FAILURE
- saveQuery(filename: char, results: int = 0) int [broncode]¶
Save query to disk. Returns
MS_SUCCESS
orMS_FAILURE
- saveQueryAsGML(*args) int [broncode]¶
Save query to disk. Returns
MS_SUCCESS
orMS_FAILURE
- scaleExtent(zoomfactor: double, minscaledenom: double, maxscaledenom: double) int [broncode]¶
Scale the map extent using the zoomfactor and ensure the extent within the minscaledenom and maxscaledenom domain. If minscaledenom and/or maxscaledenom is 0 then the parameter is not taken into account. Returns
MS_SUCCESS
orMS_FAILURE
- selectOutputFormat(imagetype: char const) void [broncode]¶
Set the map’s active output format to the internal format named imagetype. Built-in formats are “PNG”, “PNG24”, “JPEG”, “GIF”, “GTIFF”.
- setCenter(center: pointObj) int [broncode]¶
Set the map center to the given map point. Returns
MS_SUCCESS
orMS_FAILURE
.
- setConfigOption(key: char, value: char) void [broncode]¶
Set the indicated key configuration option to the indicated value. Equivalent to including a CONFIG keyword in a map file.
- setExtent(minx: double, miny: double, maxx: double, maxy: double) int [broncode]¶
Set the map extent, returns
MS_SUCCESS
orMS_FAILURE
. This method will correct the extents (width/height ratio) before setting the minx, miny, maxx, maxy values. See extent properties to set up a custom extent fromrectObj
.
- setFontSet(filename: char) int [broncode]¶
- . Load fonts defined in filename into map fontset. The existing fontset is cleared.
Returns
MS_SUCCESS
orMS_FAILURE
- setImageType(imagetype: char const) void [broncode]¶
Sets map outputformat to the named format.
Notitie
mapObj.setImageType()
remains in the module but its use is deprecated in favor ofmapObj.selectOutputFormat()
.
- setLayerOrder(order: PyObject) int [broncode]¶
Python MapScript only - sets the map layer order using a native sequence
- setLayersDrawingOrder(panIndexes: int) int [broncode]¶
Set map layer drawing order. Note Unless the proper typemap is implemented for the module’s language users will not be able to pass arrays or lists to this method and it will be unusable.
- setOutputFormat(format: outputFormatObj) void [broncode]¶
Sets map outputformat.
- setProjection(proj4: char) int [broncode]¶
Set map projection from PROJ definition string proj4.
- setRotation(rotation_angle: double) int [broncode]¶
Set map rotation angle. The map view rectangle (specified in EXTENTS) will be rotated by the indicated angle in the counter- clockwise direction. Note that this implies the rendered map will be rotated by the angle in the clockwise direction.
Returns
MS_SUCCESS
orMS_FAILURE
- setSize(width: int, height: int) int [broncode]¶
- setSymbolSet(szFileName: char) int [broncode]¶
Load symbols defined in filename into map symbolset. The existing symbolset is cleared. Returns
MS_SUCCESS
orMS_FAILURE
- setWKTProjection(wkt: char) int [broncode]¶
Sets map projection from OGC definition wkt.
- set_height(value)[broncode]¶
Python MapScript only Set the map height value of the map size
- set_width(value)[broncode]¶
Python MapScript only Set the map width value of the map size
- zoomPoint(zoomfactor: int, poPixPos: pointObj, width: int, height: int, poGeorefExt: rectObj, poMaxGeorefExt: rectObj) int [broncode]¶
Zoom by the given factor to a pixel position within the width and height bounds. If max_extent is not NULL, the zoom is constrained to the max_extents
Returns
MS_SUCCESS
orMS_FAILURE
- zoomRectangle(poPixRect: rectObj, width: int, height: int, poGeorefExt: rectObj, poMaxGeorefExt: rectObj) int [broncode]¶
Set the map extents to a given extents. Returns
MS_SUCCESS
orMS_FAILURE
on error
- zoomScale(scale: double, poPixPos: pointObj, width: int, height: int, poGeorefExt: rectObj, poMaxGeorefExt: rectObj) int [broncode]¶
Zoom by the given factor to a pixel position within the width and height bounds. If max_extent is not NULL, the zoom is constrained to the max_extents