logical control/boolean values
|
MS_VERSION - character (3.6.1)
|
|
MS_TRUE/MS_ON/MS_YES - integer (1)
|
|
MS_FALSE/MS_OFF/MS_NO - integer (0)
|
logical control/status values
|
MS_DEFAULT (layer) - integer (2)
|
|
MS_EMBED (legend & scalebar) - integer (3)
|
|
MS_DELETE (layer) - integer (4)
|
|
map units
|
MS_INCHES - integer
|
|
MS_FEET - integer
|
|
MS_MILES - integer
|
|
MS_METERS - integer
|
|
MS_KILOMETERS - integer
|
|
MS_DD - integer
|
|
MS_PIXELS - integer
|
|
layer types
|
MS_LAYER_POINT - integer
|
|
MS_LAYER_LINE - integer
|
|
MS_LAYER_POLYGON - integer
|
|
MS_LAYER_RASTER - integer
|
|
MS_LAYER_ANNOTATION - integer
|
|
MS_LAYER_QUERY - integer
|
|
MS_LAYER_CIRCLE - integer
|
|
font types
|
MS_TRUETYPE - integer
|
|
MS_BITMAP - integer
|
|
label positions
|
MS_UL - integer
|
|
MS_LR - integer
|
|
MS_UR - integer
|
|
MS_LL - integer
|
|
MS_CR - integer
|
|
MS_CL - integer
|
|
MS_UC - integer
|
|
MS_LC - integer
|
|
MS_CC - integer
|
|
MS_AUTO - integer
|
|
MS_XY - integer (arrangement matters for auto placement, don't change it)
|
|
label size (bitmap only)
|
MS_TINY - integer
|
|
MS_SMALL - integer
|
|
MS_MEDIUM - integer
|
|
MS_LARGE - integer
|
|
MS_GIANT - integer
|
|
shape types
|
MS_SHAPE_POINT - integer
|
|
MS_SHAPE_LINE - integer
|
|
MS_SHAPE_POLYGON - integer
|
|
MS_SHAPE_NULL - integer
|
|
shapefile types
|
MS_SHAPEFILE_POINT (1)
|
|
MS_SHAPEFILE_ARC (3)
|
|
MS_SHAPEFILE_POLYGON (5)
|
|
MS_SHAPEFILE_MULTIPOINT (8)
|
|
query/join types/modes
|
MS_SINGLE - integer (0)
|
|
MS_MULTIPLE - integer (1)
|
|
file types
|
MS_FILE_MAP - integer
|
|
MS_FILE_SYMBOL - integer
|
|
MS_FILE_DEFAULT - integer (MS_FILE_MAP)
|
|
querymap styles
|
MS_NORMAL - integer
|
|
MS_HILITE - integer
|
|
MS_SELECTED - integer
|
|
connection type
|
MS_INLINE - integer
|
|
MS_SHAPEFILE - integer
|
|
MS_TILED_SHAPEFILE - integer
|
|
MS_SDE - integer
|
|
MS_OGR - integer
|
|
MS_POSTGIS - integer
|
|
MS_WMS - integer
|
|
MS_ORACLESPATIAL - integer
|
|
image type
|
MS_GIF - integer (0)
|
|
MS_PNG - integer (1)
|
|
MS_JPEG - integer (2)
|
|
MS_WBMP - integer (3)
|
|
MS_GML - integer (4)
|
|
line joins & caps
|
MS_CJC_NONE - integer
|
|
MS_CJC_BEVEL - integer
|
|
MS_CJC_BUTT - integer
|
|
MS_CJC_MITER - integer
|
|
MS_CJC_ROUND - integer
|
|
MS_CJC_SQUARE - integer
|
|
MS_CJC_TRIANGLE - integer
|
return codes
|
MS_SUCCESS - integer
|
|
MS_FAILURE - integer
|
|
MS_DONE - integer
|
|
Members:
|
See the mapfile documentation for a list of parameters that can be changed.
|
|
backgroundcolor - integer - rw.
|
|
color - integer - rw.
|
|
joins - joinObj - rw - see the mapfile documentation.
|
|
label - labelObj - rw.
|
|
maxscale - double - .
|
|
maxsize - integer - rw.
|
|
minscale - double - .
|
|
minsize - integer - rw.
|
|
name - character - rw - should be unique within a layer.
|
|
numjoins - integer - rw.
|
|
outlinecolor - integer - rw.
|
|
overlaybackgroundcolor - integer - rw.
|
|
overlaycolor - integer - rw.
|
|
overlaymaxsize - integer - rw.
|
|
overlayminsize - integer - rw.
|
|
overlayoutlinecolor - integer - rw.
|
|
overlaysize - integer - rw.
|
|
overlaysizescaled - integer - rw.
|
|
overlaysymbol - integer - rw.
|
|
overlaysymbolname - character - rw.
|
|
size - integer - rw.
|
|
sizescaled - integer - rw.
|
|
status - integer - rw.
|
|
symbol - integer - rw.
|
|
symbolname - character - rw.
|
|
template - character - rw.
|
|
title - character - - used for legend labelling.
|
|
type - integer - rw.
|
Methods:
|
Method
|
Description
|
Returns
|
Notes
|
|
createLegendIcon(mapObj, layerObj, width, height);
|
Creates a new canvas image for adding legend icons to.
|
imageObj
|
|
|
drawLegendIcon(mapObj, layerObj, width, height, dstImage, dstX, dstY)
|
Draws the icon on an existing legend canvas image.
|
integer
|
dstImage IS a pre-existing imageObj.
|
|
setExpression(character string)
|
|
integer
|
|
|
getMetaData(character name)
|
|
character
|
|
|
setMetaData(character name,character value)
|
|
integer
|
MS_FAILURE,MS_SUCCESS
|
|
setText(layerObj,character string)
|
|
integer
|
|
Members:
|
angle - double - rw.
|
|
antialias - integer - rw.
|
|
autoangle - integer - rw - true or false.
|
|
autominfeaturesize - integer - rw - true or false.
|
|
backgroundcolor - integer - rw.
|
|
backgroundshadowcolor - integer - rw.
|
|
backgroundshadowsizex - integer - rw.
|
|
backgroundshadowsizey - integer - rw.
|
|
buffer - integer - rw - space to reserve around a label.
|
|
color - integer - rw.
|
|
font - character - rw.
|
|
force - integer - rw - labels Must be drawn.
|
|
mindistance - integer - rw.
|
|
minfeaturesize - integer - rw - minimum feature size (in pixels) to label.
|
|
maxsize - integer - rw.
|
|
minsize - integer - rw.
|
|
offsetx - integer - rw.
|
|
offsety - integer - rw.
|
|
outlinecolor - integer - rw.
|
|
partials - integer - rw - can labels run off an image.
|
|
position - integer - rw.
|
|
shadowcolor - integer - rw.
|
|
shadowsizex - integer - rw.
|
|
shadowsizey - integer - rw.
|
|
size - integer - rw.
|
|
sizescaled - integer - rw.
|
|
type - MS_FONT_TYPE - rw.
|
|
wrap - character - rw.
|
Members:
|
|
|
annotate - integer - rw - boolean flag for annotation.
|
|
classitem - character - rw - .DBF item to be used for symbol lookup.
|
|
classitemindex - integer - rw.
|
|
connection - character - rw.
|
|
connectiontype - MS_CONNECTION_TYPE - rw.
|
|
data - character - rw - filename, can be relative or full path.
|
|
dump - integer - rw.
|
|
filteritem - character - rw.
|
|
filteritemindex - integer - rw.
|
|
footer - character - rw - only used with multi result queries.
|
|
group - character - rw - should not be unique.
|
|
header - character - rw.
|
|
index - integer - rw.
|
|
items - character - rw.
|
|
labelangleitem - character - rw.
|
|
labelangleitemindex - integer - rw.
|
|
labelcache - integer - rw.
|
|
labelitem - character - rw.
|
|
labelitemindex - integer - rw.
|
|
labelmaxscale - double - rw.
|
|
labelminscale - double - rw.
|
|
labelrequires - character - rw.
|
|
labelsizeitem - character - rw.
|
|
labelsizeitemindex - integer - rw.
|
|
maxfeatures - integer - rw.
|
|
maxscale - double - rw.
|
|
minscale - double - rw.
|
|
name - character - rw - should be unique.
|
|
numclasses - integer - ro - number of classes in the layer.
|
|
numitems - integer - rw.
|
|
offsite - integer - rw - color index to treat as transparent for raster layers.
|
|
postlabelcache - integer - rw - on or off.
|
|
requires - character - rw - context expressions, simple enough to not use expressionObj.
|
|
resultcache - resultCacheObj - rw - holds the results of a query against this layer.
|
|
sizeunits - integer - rw - applies to all classes.
|
|
status - integer - rw - on or off.
|
|
styleitem - character - rw - item to be used for style lookup - can also be 'AUTO'.
|
|
styleitemindex - integer - rw.
|
|
symbolscale - double - rw - scale at which symbols are default size.
|
|
template - character - rw - global template, used across all classes.
|
|
tileindex - character - rw - layer index file for tiling support.
|
|
tileitem - character - rw.
|
|
tileitemindex - integer - rw.
|
|
tolerance - double - rw - search buffer for point and line queries (in toleranceunits).
|
|
toleranceunits - integer - rw.
|
|
transform - integer - rw - does this layer have to be transformed to file coordinates.
|
|
transparency - integer - rw - transparency value 0-100.
|
|
type - MS_LAYER_TYPE - rw.
|
|
units - integer - rw - units of the projection.
|
Methods:
|
Method
|
Description
|
Returns
|
Notes
|
|
addFeature(shapeObj shape)
|
|
integer, -1 on failure
|
|
close()
|
|
void
|
|
draw(mapObj, imageObj)
|
Draws a single layer and adds labels to the cache if required.
|
integer
|
|
|
drawQuery(mapObj, imageObj)
|
|
integer
|
|
getClass(integer index)
|
Retrieves a classObj given an index value.
|
classObj
|
Class index values start at 0. Total number of classes defined in a layer is $layer->{numclasses}.
|
|
getItem(integer)
|
Returns an existing item name.
|
character
|
|
getMetaData(character name)
|
|
character
|
|
getProjection()
|
|
character
|
|
getResult(integer member)
|
Retrieves the nth member of the result cache created by the previous query, ie. queryByPoint.
|
resultCacheMemberObj
|
|
getShape(shapeObj, integer tileindex, integer shapeindex)
|
|
integer
|
See open() & close().
Seems to equate to new mapscript::shapefileObj(), get(), & undef.
|
|
open(character path)
|
|
integer
|
|
queryByAttributes(mapObj, integer mode)
|
|
integer
|
|
queryByFeatures(mapObj, integer slayer)
|
Queries a single layer using another set of results.
|
integer
|
|
|
queryByPoint(mapObj,pointObj,integer mode,double buffer)
|
Queries a single layer using a point.
|
integer
|
"mode" is MS_SINGLE or MS_MULTIPLE. Defaults to tolerances set in the mapfile but can use a constant buffer instead.
|
|
queryByRect(mapObj,rectObj)
|
Queries a single layer using a rectangle.
|
integer
|
|
|
queryByShape(mapObj,shapeObj)
|
|
integer
|
|
setFilter(character string filter)
|
|
integer
|
|
setProjection(character string parameters)
|
Sets the projection and coordinate system for the layer.
|
integer
|
Parameters are given as a single string of comma delimited PROJ.4 parameters, ie. "proj=utm,ellps=GRS80,zone=15,north,no_defs".
|
|
setMetaData(character name,character value)
|
|
integer - MS_FAILURE,MS_SUCCESS
|
|
setWKTProjection(character string)
|
|
integer
|
|
getWMSFeatureInfoURL(mapObj,integer click_x,integer click_y,integer feature_count,character info_format)
|
|
character
|
Members:
|
height - integer - rw.
|
|
imagecolor - colorObj - rw.
|
|
interlace - integer - rw.
|
|
keysizex - integer - rw.
|
|
keysizey - integer - rw.
|
|
keyspacingx - integer - rw.
|
|
keyspacingy - integer - rw.
|
|
label - labelObj - rw.
|
|
outlinecolor - integer - rw - color of outline of box, -1 for no outline.
|
|
position - integer - rw - for embeded legends.
|
|
postlabelcache - integer - rw.
|
|
status - integer - rw - ON, OFF or EMBED.
|
|
template - character - rw.
|
|
transparent - integer - rw.
|
|
width - integer - rw.
|
Members:
|
|
|
Parameters that consist of a list (eg. size) can be accessed using individual list members- see below.
|
|
All parameter names are to be given in lowercase.
|
|
cellsize - double - rw - in map units.
|
|
extent - rectObj - rw - map extent array.
|
|
height - integer - rw.
|
|
imagecolor - colorObj - rw - holds the initial image color value.
|
|
imagequality - integer - rw.
|
|
imagetype - integer - rw.
|
|
interlace - integer - rw.
|
|
labelcache - labelCacheObj - rw.
|
|
layerorder - integer - rw.
|
|
layers - layerObj - rw.
|
|
legend - legendObj - rw.
|
|
name - character - rw - small identifier for naming etc.
|
|
numlayers - integer - ro - number of layers in the map.
|
|
palette - paletteObj - rw - paletteObj is used to hold colors while a mapfile is read.
|
|
querymap - queryMapObj - rw.
|
|
reference - referenceMapObj - rw.
|
|
resolution - integer - rw.
|
|
scale - double - rw - scale of the output image.
|
|
scalebar - scalebarObj - rw.
|
|
shapepath - character - rw - where are the shape files located.
|
|
status - integer - rw - map creation on or off.
|
|
transparent - integer - rw.
|
|
units - MS_UNITS - rw - units of the projection.
|
|
web - webObj - rw.
|
|
width - integer - rw.
|
|
map, legend, scalebar, and reference map size use height and width
|
|
legend keysize use keysizex and keysizey
|
|
legend keyspacing use keyspacingx and keyspacingy
|
|
Methods:
|
Method
|
Description
|
Returns
|
Notes
|
|
addColor(integer red,integer green,integer blue)
|
Adds a color to the maps palette.
|
integer
|
Color values can range from 0 to 255. Must be called prior to draw() or prepareImage().
|
|
draw()
|
Renders a map.
|
imageObj
|
|
|
drawLabelCache(imageObj)
|
Renders the labels for a map.
|
integer
|
Done as part of the draw() method but may need called when using other object draw methods.
|
|
drawLegend()
|
Renders a legend.
|
imageObj
|
|
|
drawQuery()
|
Renders a query map.
|
imageObj
|
|
drawReferenceMap()
|
Renders a reference map.
|
imageObj
|
|
|
drawScalebar
|
Renders a scalebar.
|
imageObj
|
|
|
embedLegend(imageObj)
|
Embeds a legend in a map.
|
integer
|
Adds legend to label cache. Invoke drawLabelCache(imageObj) to render (unless postlabelcache is set).
|
|
embedScalebar(image)
|
Embeds a scalebar in a map.
|
integer
|
Adds scalebar to label cache. Invoke drawLabelCache(imageObj) to render (unless postlabelcache is set).
|
|
getImageToVar(imageObj,character varname)
|
|
integer
|
|
getLayer(integer index)
|
Retrieves a layer by index.
|
layerObj
|
Layer indexes start with 0. Total number of layers in a mapfile is $map->{numlayers};.
|
|
getLayerByName(character name)
|
Retrieves a layer by name.
|
layerObj
|
If multiple layers exist with the same name the first occurence is returned.
|
|
getLayersdrawingOrder()
|
|
integer
|
|
getMetaData(character name)
|
|
character
|
|
mapObj_getNumSymbols()
|
|
integer
|
|
getProjection()
|
|
character
|
|
getSymbolByName(character name)
|
Retrieves the symbol index by name.
|
integer -1 if symbol is not found
|
|
|
moveLayerdown(layerindex)
|
|
integer
|
|
moveLayerup(layerindex)
|
|
integer
|
|
nextLabel()
|
Allows you to step through the label cache.
|
labelCacheMemberObj
|
One reason to do this would be to produce an imagemap based on annotation or post process a map by avoiding text.
|
|
prepareImage()
|
Initializes an image for drawing a map.
|
imageObj
|
Must be called prior to calling the draw methods for other objects (not draw()).
|
|
prepareQuery()
|
|
void
|
|
processLegendTemplate(names,values,numentries)
|
|
character
|
|
processQueryTemplate(names,values,numentries)
|
|
character
|
|
processTemplate(bGenerateImages,names,values,numentries)
|
|
character
|
|
queryByFeatures(int slayer)
|
Queries a group of layers using another set of results.
|
integer
|
|
queryByPoint(point,int mode,double buffer)
|
Queries a group of layers using a point.
|
integer
|
"mode" is MS_SINGLE or MS_MULTIPLE. Defaults to tolerances set in the mapfile but can use a constant buffer instead.
|
|
queryByRect(rectObj)
|
Queries a group of layers using a rectangle.
|
integer
|
|
|
queryByShape(shapeObj)
|
|
integer
|
|
save(char filename)
|
Writes the contents of a mapfile to disk.
|
integer
|
|
|
saveQuery(char filename)
|
|
integer
|
|
saveQueryAsGML(char filename)
|
|
integer
|
|
setLayersdrawingOrder(panIndexes)
|
|
integer
|
|
setMetaData(char name,char value)
|
|
integer
|
|
setProjection(string parameters)
|
Sets the projection and coordinate system for the map.
|
integer
|
Parameters are given as a single string of comma delimited PROJ.4 parameters, ie. "proj=utm,ellps=GRS80,zone=15,north,no_defs".
|
|
setSymbolSet(szFileName)
|
|
integer
|
|
setWKTProjection(char string)
|
|
integer
|
Methods:
|
Method
|
Description
|
Returns
|
Notes
|
|
distanceToLine(pointObj a,pointObj b)
|
|
double
|
|
|
distanceToPoint(pointObj)
|
|
double
|
|
|
distanceToShape(shapeObj)
|
|
double, -1 if shape type is not recognized
|
|
|
draw(mapObj,layerObj,imageObj,integer classindex,character text)
|
Draws an individual point using layerObj.
|
integer
|
The class_index is used to classify the point based on the classes defined for layerObj.
The text string is used to annotate the point.
|
|
project(projectionObj in,projectionObj out)
|
|
integer
|
|
Methods:
|
Method
|
Description
|
Returns
|
Notes
|
|
add(shapeObj)
|
Appends a shape to an open file.
|
integer
|
|
|
addPoint(pointObj)
|
|
integer
|
|
|
get(integer index,shapeObj)
|
Retrieves a shape by index.
|
integer, -1 if index is < 0 or >= number of shapes
|
|
|
getExtent(integer index,rectObj)
|
Retrieves a shape bounding box by index.
|
void
|
|
|
getPoint(integer index,pointObj)
|
|
integer, -1 if index is < 0 or >= number of shapes
|
|
|
getTransformed(mapObj,integer index,shapeObj)
|
|
integer, -1 if index is < 0 or >= number of shapes
|
|