Classes/Objects:
Access to the mapserver API is provided largely through a series of classes.
These classes allow the programmer to:

- manipulate virtually all aspects of a mapfile
- draw entire maps, layers or individual shapes
- perform spatial queries using points, areas or other features
- read/write shapefiles
- perform attribute queries

The main MapScript classes are given in the table below.
Each class is described in detail later in this document.

classObj holds all class parameters
exists within a layerObj
colorObj
errorObj
fontSetObj
graticuleObj
imageObj
labelCacheMemberObj holds a single element from the label cache
labelCacheObj
labelObj
layerObj holds all layer parameters
exists within a mapObj
legendObj
lineObj made up of pointObjs
may or may not be a closed ring
mapObj holds all mapfile parameters
markerCacheMemberObj
outputFormatObj
OWSRequest
pointObj simple class to hold a 2-D point
projectionObj
queryMapObj
rectObj class used to represent a 2-D rectangle
defined using minimum and maximum x and y coordinates
referenceMapObj
resultCacheMemberObj
resultCacheObj
scalebarObj
shapefileObj class used to access spatial information (i.e. features) stored in an ESRI shapefile
shapeObj made up of lineObjs
styleObj
symbolObj
symbolSetObj
msTiledSHPLayerInfo
vectorObj
webObj
intarray
hashTableObj


classObj:

Constructors:
 new mapscript::classObj(layerObj) class->clone() layer->getClass(1) layer->removeClass(1)
Provides access to all class parameters (color, symbol, label, & etc...).

Members: See the mapfile documentation also.
  • debug - integer - rw.
    		•
  • keyimage - character - rw.
    		•
  • label - labelObj - rw.
    		•
  • layer - layerObj - rw.
    		•
  • maxscale - double - rw.
    		•
  • metadata - hashTableObj - rw.
    		•
  • minscale - double - rw.
    		•
  • name - character - rw - should be unique within a layer.
    		•
  • numstyles - integer - rw.
    		•
  • status - integer - rw.
    		•
  • template - character - rw.
    		•
  • title - character - rw - used for legend labelling.
    		•
  • type - integer - rw.
    		•

    Methods: Method Description Returns Notes
    clone(); Creates a new clone of the existing class. classObj
    createLegendIcon(mapObj, layerObj, width, height) 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.
    getExpressionString() character
    getFirstMetaDataKey() character
    getMetaData(character name) character
    getNextMetaDataKey(character key) character
    getStyle(integer) styleObj
    insertStyle(styleObj, integer) integer
    moveStyleDown(integer) integer
    moveStyleUp(integer) integer
    removeStyle(integer) styleObj
    setExpression(character string) integer
    setMetaData(character name,character value) integer MS_FAILURE,MS_SUCCESS
    setText(layerObj,character string) integer


    colorObj:

    Constructors:
    		 new mapscript::colorObj(red, green, blue, pen) legend->{imagecolor} legend->{outlinecolor} map->{imagecolor}
    querymap->{color} referencemap->{color} referencemap->{outlinecolor} scalebar->{backgroundcolor}
    scalebar->{color} scalebar->{imagecolor} scalebar->{outlinecolor} style->{background}
    style->{color} style->{outlinecolor}

    Members:
  • blue - integer - rw.
    		•
  • green - integer - rw..
    		•
  • pen - integer - rw.
    		•
  • red - integer - rw.
    		•

    Methods: Method Description Returns Notes
    setHex(character hex color string) integer
    setRGB(integer red, integer green, integer blue) integer
    toHex() character hex color string


    errorObj:

    Constructors:
    		 new mapscript::errorObj() error->next()

    Members:
  • code - integer - rw.
    		•
  • message - character - rw..
    		•
  • routine - character - rw.
    		•

    Methods: Method Description Returns Notes
    next() errorObj


    fontSetObj:

    Constructors:
    		 new mapscript::fontSetObj() map->{fontset}

    Members:
  • filename - character - ro.
    		•
  • numfonts - integer - ro.
    		•

    Methods: Method Description Returns Notes
    none


    gracticuleObj:

    Constructors:
    		 new mapscript::graticuleObj()

    Members:
  • blabelaxes - integer - rw.
    		•
  • bvertical - integer - rw.
    		•
  • dendlatitude - double - rw.
    		•
  • dendlongitude - double - rw.
    		•
  • dincrementlatitude - double - rw.
    		•
  • dincrementlongitude - double - rw.
    		•
  • dstartlatitude - double - rw.
    		•
  • dstartlongitude - double - rw.
    		•
  • dwhichlatitude - double - rw.
    		•
  • dwhichlongitude - double - rw.
    		•
  • extent - rectObj - rw.
    		•
  • ilabelstate - integer - rw.
    		•
  • ilabeltype - integer - rw.
    		•
  • maxarcs - double - rw.
    		•
  • maxincrement - double - rw.
    		•
  • maxsubdivides - double - rw.
    		•
  • minarcs - double - rw.
    		•
  • minincrement - double - rw.
    		•
  • minsubdivides - double - rw.
    		•
  • labelformat - character - rw.
    		•
  • pboundinglines - lineObj - rw.
    		•
  • pboundingpoints - pointObj - rw.
    		•

    Methods: Method Description Returns Notes
    none


    imageObj:

    Constructors:
    		 new mapscript::imageObj(width, height, input_format, file) class->createLegendIcon(map, layer, 100, 100) map->draw() map->drawLegend()
    map->drawQuery() map->drawReferenceMap() map->drawScalebar() map->prepareImage()
    symbol->getImage(outputformat)

    Members:
  • format - outputFormatObj - rw.
    		•
  • height - integer - ro.
    		•
  • imagepath - character - ro.
    		•
  • imageurl - character - ro.
    		•
  • renderer - integer - rw.
    		•
  • size - integer - rw.
    		•
  • width - integer - ro.
    		•

    Methods: Method Description Returns Notes
    save(character filename, mapObj) void
    write(filehandle) integer


    labelCacheMemberObj:

    Constructors:
    		 labelcache->{labels} map->nextLabel()


    Members:
  • classindex - integer - ro.
    		•
  • featuresize - double - ro.
    		•
  • label - labelObj - ro.
    		•
  • layerindex - integer - ro - indexes.
    		•
  • numstyles - integer - ro.
    		•
  • point - pointObj - ro - label point.
    		•
  • poly - shapeObj - ro - label bounding box.
    		•
  • shapeindex - integer - ro.
    		•
  • status - integer - ro - has the label been drawn or not.
    		•
  • styles - styleObj - ro.
    		•
  • text - character - ro.
    		•
  • tileindex - integer - ro.
    		•

    Methods: Method Description Returns Notes
    none


    labelCacheObj:

    Constructor:
    		 new mapscript::labelCacheObj() map->{labelcache}

    Members:
  • cachesize - integer - ro.
    		•
  • labels - labelCacheMemberObj - ro.
    		•
  • markers - markerCacheMemberObj - ro.
    		•
  • markercachesize - integer - ro.
    		•
  • numlabels - integer - ro.
    		•
  • nummarkers - integer - ro.
    		•

    Methods: Method Description Returns Notes
    none


    labelObj:

    Constructors:
    		 new mapscript::labelObj() class->{label} labelCacheMemberObj->{label} legendObj->{label}
    scalebar->{label}

    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.
    		•
  • encoding - character - 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.
    		•
  • type - MS_FONT_TYPE - rw.
    		•
  • wrap - character - rw.
    		•

    Methods: Method Description Returns Notes
    none


    layerObj:

    Constructor:
    		 new mapscript::layerObj(mapObj) class->{layer} layer->clone() map->getLayer(1)
    map->getLayerByName("parcel")

    Members:
  • bandsitem - character - rw.
    		•
  • classitem - character - rw - .DBF item to be used for symbol lookup.
    		•
  • connection - character - rw.
    		•
  • connectiontype - MS_CONNECTION_TYPE - rw.
    		•
  • data - character - rw - filename, can be relative or full path.
    		•
  • debug - integer - rw.
    		•
  • dump - integer - rw.
    		•
  • extent - rectObj - ro.
    		•
  • filteritem - character - rw.
    		•
  • footer - character - rw - only used with multi result queries.
    		•
  • group - character - rw - should not be unique.
    		•
  • header - character - rw.
    		•
  • index - integer - ro.
    		•
  • 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.
    		•
  • map - mapObj - ro.
    		•
  • maxfeatures - integer - rw.
    		•
  • maxscale - double - rw.
    		•
  • metadata - hashTableObj - rw.
    		•
  • minscale - double - rw.
    		•
  • name - character - rw - should be unique.
    		•
  • numclasses - integer - ro - number of classes in the layer.
    		•
  • numitems - integer - ro.
    		•
  • numjoins - integer - ro.
    		•
  • numprocessing - integer - ro.
    		•
  • 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.
    		•
  • 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'.
    		•
  • 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) integer, -1 on failure
    shapeObj defaults to 0.
    addProcessing(character directive) null
    applySLD(character sld, character stylelayer) integer
    applySLDURL(character sld, character stylelayer) integer
    clearProcessing() integer
    clone() layerObj
    close() void
    draw(mapObj, imageObj) Draws a single layer and adds labels to the cache if required. integer mapObj defaults to current.
    imageObj defaults to 0.
    drawQuery(mapObj, imageObj) integer mapObj defaults to current.
    imageObj defaults to 0.
    executeWFSGetFeature(layerObj) character layerObj defaults to current.
    generateSLD() character
    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}.
    getExtent() rectObj
    getFeature(integer shapeindex, integer tileindex) shapeObj
    getFilterString character
    getFirstMetaDataKey() character
    getItem(integer) character
    getMetaData(character name) character
    getNextMetaDataKey(character lastkey) character
    getNumFeatures() integer
    getNumResults() integer
    getProcessing(integer index) character
    getProjection() character
    getResults() resultCacheObj
    getShape(shapeObj, integer tileindex, integer shapeindex) integer See open() & close().
    shapeObj defaults to 0.
    getWMSFeatureInfoURL(mapObj,integer click_x,integer click_y,integer feature_count,character info_format) character mapObj defaults to current.
    insertClass(classObj, integer index) integer classObj defaults to 0.
    isVisible() integer
    moveClassDown(integer index) integer
    moveClassUp(integer index) integer
    open() integer
    queryByAttributes(mapObj, character qitem, character qstring, integer mode) integer mapObj defaults to current.
    queryByFeatures(mapObj, integer slayer) Queries a single layer using another set of results. integer mapObj defaults to current.
    queryByIndex(mapObj, integer tileindex, integer shapeindex, integer bAddToQuery) integer mapObj defaults to current. bAddToQuery defaults to 0.
    queryByPoint(mapObj,pointObj,integer mode,double buffer) Queries a single layer using a point & surrounding buffer. integer "mode" is MS_SINGLE or MS_MULTIPLE. Defaults to tolerances set in the mapfile but can use a constant buffer instead.
    mapObj defaults to current.
    pointObj defaults to 0.
    queryByRect(mapObj,rectObj) Queries a single layer using a rectangle. integer mapObj defaults to current.
    queryByShape(mapObj,shapeObj) integer mapObj defaults to current.
    shapeObj defaults to 0.
    removeClass(integer index) classObj
    removeMetaData(character name) integer MS_FAILURE,MS_SUCCESS
    setExtent(double minx, double miny, double maxx, double maxy) integer All arguments default to -1.
    setFilter(character filter) integer
    setMetaData(character name,character value) integer MS_FAILURE,MS_SUCCESS
    setProcessing(character directive) null
    setProcessingKey(character key, character value) null
    setProjection(character proj4) 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".
    setWKTProjection(character projection) integer


    legendObj:

    Constructor:
    		 new mapscript::legendObj() map->{legend}

    Members:
  • height - integer - rw.
    		•
  • imagecolor - colorObj - rw.
    		•
  • keysizex - integer - rw.
    		•
  • keysizey - integer - rw.
    		•
  • keyspacingx - integer - rw.
    		•
  • keyspacingy - integer - rw.
    		•
  • label - labelObj - rw.
    		•
  • map - mapObj - rw.
    		•
  • outlinecolor - colorObj - rw - color of outline of box.
    		•
  • position - integer - rw - for embeded legends.
    		•
  • postlabelcache - integer - rw.
    		•
  • status - integer - rw.
    		•
  • template - character - rw.
    		•
  • width - integer - rw.
    		•

    Methods: Method Description Returns Notes
    none


    lineObj:

    Constructors:
    		 new mapscript::lineObj() graticule->{pboundinglines} shape->{line} shape->get(1)
    symbol->getPoints()

    Members:
  • numpoints - integer - ro - number of points in this line.
    		•
  • point - pointObj - ro.
    		•

    Methods: Method Description Returns Notes
    add(pointObj) Adds a point to the end of the line. integer, -1 on failure pointObj defaults to 0.
    get(integer) pointObj
    project(projectionObj in,projectionObj out) integer Both projectionObj default to 0.
    set(integer vertex, pointObj) Alter a vertex. integer pointObj defaults to 0.


    mapObj:

    Constructor:
    		 new mapscript::mapObj(mapfile name) layer->{map} legend->{map} map->clone()
    referencemap->{map} web->{map}
    If the filename is undefined an empty mapObj is created and initialized.

    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.
    		•
  • configoptions - hashTableObj - rw.
    		•
  • datapattern - character - rw.
    		•
  • debug - integer - rw.
    		•
  • extent - rectObj - rw.
    		•
  • fontset - fontSetObj - rw.
    		•
  • gt - geotransformObj - rw - geotransformObj is used for reprojecting WCS (raster).
    		•
  • height - integer - rw.
    		•
  • imagecolor - colorObj - rw - holds the initial image color value.
    		•
  • imagequality - integer - rw.
    		•
  • imagetype - character - ro.
    		•
  • interlace - integer - rw.
    		•
  • labelcache - labelCacheObj - rw.
    		•
  • layerorder - integer - rw.
    		•
  • legend - legendObj - rw.
    		•
  • mappath - character - rw.
    		•
  • maxsize - integer - rw.
    		•
  • name - character - rw - small identifier for naming etc.
    		•
  • numlayers - integer - ro - number of layers in the map.
    		•
  • numoutputformats - integer - ro.
    		•
  • outputformat - outputFormatObj - ro.
    		•
  • outputformatlist - outputFormatObj - ro.
    		•
  • palette - paletteObj - rw - paletteObj is used to hold colors while a mapfile is read.
    		•
  • querymap - queryMapObj - rw.
    		•
  • reference - referenceMapObj - rw.
    		•
  • resolution - double - rw.
    		•
  • saved_extent - rectObj - 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.
    		•
  • symbolset - symbolSetObj - rw.
    		•
  • templatepattern - character - rw.
    		•
  • transparent - integer - rw.
    		•
  • units - MS_UNITS - rw - units of the projection.
    		•
  • web - webObj - rw.
    		•
  • width - integer - rw.
    		•

    Methods: Method Description Returns Notes
    appendOutputFormat(outputFormatObj) integer
    applyConfigOptions() null
    applySLD(character sld) integer
    applySLDURL(character sld) integer
    clone() mapObj
    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
    embedScalebar(imageObj) Embeds a scalebar in a map. integer
    freeQuery(integer qlayer) integer qlayer defaults to -1.
    generateSLD() character
    getConfigOption(character key) character
    getFirstMetaDataKey() character
    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 array
    getMetaData(character name) character
    getNextMetaDataKey(character lastkey) character
    getNumSymbols() integer
    getOutputFormatByName(character name) outputFormatObj
    getProjection() character
    getSymbolByName(character name) Retrieves the symbol index by name. integer -1 if symbol is not found
    insertlayer(layerObj, integer index) integer
    loadMapContext(character szFileName, integer useUniqueNames) integer useUniqueNames defaults to false.
    loadOWSParameters(cgiRequestObj, character wmtver_string) integer cgiRequestObj is used
    cgiRequestObj defaults to 0.
    wmtver_string defailts to 1.1.1
    loadQuery(character filename) integer
    moveLayerdown(integer layerindex) integer
    moveLayerup(integer 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(character names,character values,integer numentries) character names & values defaults to 0.
    processQueryTemplate(character names, character values, integer numentries) character names & values defaults to 0.
    processTemplate(integer bGenerateImages,character names,character values,integer numentries) character names & values defaults to 0.
    queryByFeatures(integer slayer) Queries a group of layers using another set of results. integer
    queryByPoint(pointObj, integer 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
    removeLayer(integer index) integer
    removeMetaData(character name) integer
    removeOutputFormat(character name) integer
    save(char filename) Writes the contents of a mapfile to disk. integer
    saveMapContext(character szFileName) integer
    saveQuery(character filename) integer
    saveQueryAsGML(character filename, character ns) integer ns defaults to GOMF.
    selectOutputFormat(character imagetype) null
    setConfigOption(character key, character value) null
    setExtent(double minx, double miny, double maxx, double maxy) integer
    setFontSet(character filename) integer
    setImageType(character imagetype) null
    setLayersdrawingOrder(integer panIndexes) integer
    setMetaData(character name, character value) integer
    setOutputFormat(outputFormatObj) null
    setProjection(character proj4) 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".
    setRotation(double angle) integer
    setSize(integer width, integer height) integer
    setSymbolSet(character szFileName) integer
    setWKTProjection(character wkt) integer
    zoomPoint(integer zoomfactor, pointObj, integer width, integer height, rectObj poGeorefExt, rectObj poMaxGeorefExt) integer pointObj & both RectObj default to 0.
    zoomRectangle(rectObj, integer width, integer height, rectObj poGeorefExt, rectObj poMaxGeorefExt) integer all rectObj default to 0.
    zoomScale(double scale, pointObj, integer width, integer height, rectObj poGeorefExt, rectObj poMaxGeorefExt) integer pointObj & both RectObj default to 0.


    markerCacheMemberObj:

    Constructor:
    		 new mapscript::markerCacheMemberObj() labelcache->{markers}

    Members:
  • id - integer - ro.
    		•
  • poly - shapeObj - ro - marker bounding box (POINT layers only).
    		•

    Methods: Method Description Returns Notes
    none


    outputFormatObj:

    Constructor:
    		 new mapscript::outputFormatObj(driver, name) image->{format} map->{outputformat} map->{outputformatlist}
    map->getOutputFormatByName("GIF")

    Members:
  • bands - integer - rw.
    		•
  • driver - character - rw.
    		•
  • extension - character - rw.
    		•
  • formatoptions - character - rw.
    		•
  • imagemode - integer - rw.
    		•
  • inmapfile - integer - rw.
    		•
  • mimetype - character - rw.
    		•
  • name - character - rw.
    		•
  • numformatoptions - integer - rw.
    		•
  • refcount - integer - rw.
    		•
  • renderer - integer - rw.
    		•
  • transparent - integer - rw.
    		•

    Methods: Method Description Returns Notes
    getOption(character key, character value) character value defaults to blank.
    setExtension(character extension) null
    setMimetype(character mimetype) null
    setOption(character key, character value) null
    validate() integer


    OWSRequest:

    Constructor:
    		 new mapscript::OWSRequest()

    Members:
  • contenttype - character - rw.
    		•
  • NumParams - integer - rw.
    		•
  • postrequest - character - rw.
    		•
  • type - integer - rw.
    		•

    Methods: Method Description Returns Notes
    getName(integer index) character
    getValue(integer index) character
    getValueByName(character name) character
    setParameter(character name, character value) null


    pointObj:

    Constructors:
    		 new mapscript::pointObj(x, y, z, m) graticule->{pboundingpoints} labelcache->{point} line->{point}
    line->get(1)

    Members:
  • m - double - rw.
    		•
  • x - double - rw - x coordinate.
    		•
  • y - double - rw - y coordinate.
    		•
  • z - double - rw - z coordinate.
    		•

    Methods: Method Description Returns Notes
    distanceToPoint(pointObj) double
    distanceToSegment(pointObj a, pointObj b) double Always returns the perpendicular distance of point to segment, aka. will extend segment until perpendicular is reached.
    distanceToShape(shapeObj) double
    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
    setXY(double x, double y, double m) integer z is always set to 0.
    setXYZ(double x, double y, double z, double m) integer
    setXYZM(double x, double y, double z, double m) integer
    toString() Returns the x, y, z, & depending m of the point in a formatted string. character


    projectionObj:

    Constructor:
    		 new mapscript::projectionObj(string)

    Members:
  • numargs - integer - ro - actual number of projection args.
    		•

    Methods: Method Description Returns Notes
    none


    queryMapObj:

    Constructor:
    		 new mapscript::queryMapObj() map->{querymap}

    Members:
  • color - colorObj - rw.
    		•
  • height - integer - rw.
    		•
  • status - integer - rw.
    		•
  • style - integer - rw - HILITE, SELECTED or NORMAL.
    		•
  • width - integer - rw.
    		•

    Methods: Method Description Returns Notes
    none


    rectObj:

    Constructors:
    		 new mapscript::rectObj(minx, miny, maxx, maxy, imageunits 0/1) gracticule->{extent} layer->{extent} layer->getExtent()
    map->{extent} map->{saved_extent} referencemap->{extent} resultcache->{bounds}
    shapefile->{bounds} shapefile->{statusbounds} shape->{bounds} web->{extent}

    Members:
  • minx - double - rw - left.
    		•
  • miny - double - rw - lower.
    		•
  • maxx - double - rw - right.
    		•
  • maxy - double - rw - upper.
    		•

    Methods: Method Description Returns Notes
    draw(mapObj, layerObj, imageObj, integer classindex, character text) Draws an individual rectangle using layerObj. integer, 0 on success The class_index is used to classify the feature based on the classes defined for layerObj.
    The text string is used to annotate the shape.
    mapObj, layerObj, & imageObj default to 0.
    fit(integer width, integer height) Adjusts a rectangle to fit a size. double
    project(projectionObj in,projectionObj out) integer Both projectionObj's default to 0.
    toPolygon() shapeObj
    toString() Returns minx, miny, maxx, maxy string. character


    referenceMapObj:

    Constructor:
    		 new mapscript::referenceMapObj() map->{reference}

    Members:
  • color - colorObj - rw.
    		•
  • extent - rectObj - rw.
    		•
  • height - integer - rw.
    		•
  • image - character - rw.
    		•
  • map - mapObj - rw.
    		•
  • marker - integer - rw.
    		•
  • markername - character - rw.
    		•
  • markersize - integer - rw.
    		•
  • maxboxsize - integer - rw.
    		•
  • minboxsize - integer - rw.
    		•
  • outlinecolor - colorObj - rw.
    		•
  • status - integer - rw.
    		•
  • width - integer - rw.
    		•

    Methods: Method Description Returns Notes
    none


    resultCacheMemberObj:

    Constructor:
    		 new mapscript::resultCacheMemberObj() resultcache->getResult(1)

    Members:
  • classindex - character - ro.
    		•
  • shapeindex - integer - ro.
    		•
  • tileindex - integer - ro.
    		•

    Methods: Method Description Returns Notes
    None


    resultCacheObj:

    Constructor:
    		 new mapscript::resultCacheObj() layer->getResults()

    Members:
  • bounds - rectObj - ro.
    		•
  • numresults - integer - ro - total number of matching records.
    		•

    Methods: Method Description Returns Notes
    getResult(integer) resultCacheMemberObj


    scalebarObj:

    Constructor:
    		 new mapscript::scalebarObj() map->{scalebar}

    Members:
  • backgroundcolor - colorObj - rw.
    		•
  • color - colorObj - rw.
    		•
  • height - integer - rw.
    		•
  • imagecolor - colorObj - rw.
    		•
  • intervals - integer - rw.
    		•
  • label - labelObj - rw.
    		•
  • outlinecolor - colorObj - rw.
    		•
  • position - integer - rw - for embeded scalebars.
    		•
  • postlabelcache - integer - rw.
    		•
  • status - integer - rw - ON, OFF or EMBED.
    		•
  • style - integer - rw.
    		•
  • units - integer - rw.
    		•
  • width - integer - rw.
    		•

    Methods: Method Description Returns Notes
    none


    shapefileObj:

    Constructor:
    		 new mapscript::shapefileObj(filename, type) mstiledshplayer->{shpfile} mstiledshplayer->{tileshpfile}
    No extension is necessary.
    For existing files type should be -1.

    Members:
  • bounds - rectObj - ro - The shapefiles bounding box.
    		•
  • isopen - integer - ro.
    		•
  • lastshape - integer - ro.
    		•
  • numshapes - integer - ro - number of shapes in the shapefile.
    		•
  • source - character - ro - full path to shapefile.
    		•
  • status - character - ro.
    		•
  • statusbounds - rectObj - ro - holds extent associated with the status vector.
    		•
  • type - integer - ro - type of shapefile.
    		•

    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 shapeObj defaults to 0.
    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
    getShape(integer index) shapeObj
    getTransformed(mapObj, integer index, shapeObj) integer, -1 if index is < 0 or >= number of shapes


    shapeObj:

    Constructor:
    		 new mapscript::shapeObj(type) labelcachemember->{poly} layer->getFeature(0,0) markercachemember->{poly}
    rect->toPolygon() shapefile->getShape(0) shape->clone()

    Members:
  • bounds - rectObj - rw - the shapes bounding box.
    		•
  • classindex - integer - rw.
    		•
  • index - integer - rw.
    		•
  • line - lineObj - ro.
    		•
  • numlines - integer - ro - number of lines in this shape.
    		•
  • numvalues - integer - ro.
    		•
  • text - character - rw.
    		•
  • tileindex - integer - rw.
    		•
  • type - integer - rw - generic type of this shape.
    		•
  • values - character - ro.
    		•

    Methods: Method Description Returns Notes
    add(lineObj) Adds a line to the shape. integer
    clone() shapeObj
    contains(pointObj) integer, -1 if shape is not polygon pointObj defaults to 0.
    copy(shapeObj destination) integer
    distanceToPoint(pointObj) integer pointObj defaults to 0.
    distanceToShape(shapeObj) integer shapeObj defaults to 0.
    draw(mapObj, layerObj, imageObj) Draws an individual shape using layerObj. integer All default to 0.
    get(integer index) lineObj
    getValue(integer index) returns an existing value. character
    intersects(shapeObj) integer, -1 if shape is not line or polygon shapeObj defaults to 0.
    project(projectionObj in, projectionObj out) integer Both projectionObj default to 0.
    setBounds() void


    styleObj:

    Constructor:
    		 new mapscript::styleObj(classObj) class->getStyle(0) class->removeStyle(0) labelcachemember->{styles}
    style->clone()

    Members:
  • angle - integer - rw.
    		•
  • angleitem - character - rw.
    		•
  • antialias - integer - rw.
    		•
  • background - colorObj - rw.
    		•
  • color - colorObj - rw.
    		•
  • maxsize - integer - rw.
    		•
  • minsize - minsize - rw.
    		•
  • offsetx - integer - rw.
    		•
  • offsety - integer - rw.
    		•
  • outlinecolor - colorObj - rw.
    		•
  • size - integer - rw.
    		•
  • sizeitem - character - rw.
    		•
  • symbol - integer - rw.
    		•
  • symbolname - character - rw.
    		•

    Methods: Method Description Returns Notes
    clone styleObj


    symbolObj:

    Constructor:
    		 new mapscript::symbolObj(symbolname, imagefile) symbolset->{symbol} symbolset->getSymbol(0) symbolset->getSymbolByName("ROMANS")
    symbolset->removeSymbol(0)

    Members:
  • antialias - integer - rw.
    		•
  • character - character - rw.
    		•
  • filled - integer - rw.
    		•
  • font - character - rw.
    		•
  • gap - integer - rw.
    		•
  • imagepath - character - rw.
    		•
  • linecap - integer - rw.
    		•
  • linejoin - integer - rw.
    		•
  • linejoinmaxsize - double - rw.
    		•
  • name - character - rw.
    		•
  • numpoints - integer - ro.
    		•
  • position - integer - rw.
    		•
  • sizex - double - rw.
    		•
  • sizey - double - rw.
    		•
  • style - integer - rw.
    		•
  • stylelength - integer - rw.
    		•
  • transparent - integer - rw.
    		•
  • transparentcolor - integer - rw.
    		•
  • type - integer - rw.
    		•

    Methods: Method Description Returns Notes
    getImage(outputFormatObj) imageObj
    getPoints() lineObj
    setImage(imageObj) integer
    setPoints(lineObj) integer lineObj defaults to 0.
    setStyle(integer index, integer value) integer


    symbolSetObj:

    Constructor:
    		 new mapscript::symbolSetObj(symbolfile) map->{symbolset}

    Members:
  • filename - character - rw.
    		•
  • imagecachesize - integer - rw.
    		•
  • numsymbols - integer - ro.
    		•
  • symbol - symbolObj - ro.
    		•

    Methods: Method Description Returns Notes
    appendSymbol(symbolObj) integer
    getSymbol(integer index) symbolObj
    index(character symbolname) integer
    getSymbolByName(character symbolname) symbolObj
    removeSymbol(integer index) symbolObj
    save(character filename) integer


    msTiledSHPLayerInfo:

    Constructor:
    		 new mapscript::msTiledSHPLayerInfo()

    Members:
  • shpfile - shapefileObj - rw.
    		•
  • tilelayerindex - integer - rw.
    		•
  • tileshpfile - shapefileObj - rw.
    		•

    Methods: Method Description Returns Notes
    none


    vectorObj:

    Constructor:
    		 new mapscript::vectorObj()

    Members:
  • x - double - rw.
    		•
  • y - double - rw.
    		•

    Methods: Method Description Returns Notes
    none


    webObj:

    Constructor:
    		 new mapscript::webObj() map->{web}

    Members:
  • empty - character - rw.
    		•
  • error - character - rw - error handling.
    		•
  • extent - rectObj - rw - clipping extent.
    		•
  • footer - character - rw.
    		•
  • header - character - rw.
    		•
  • imagepath - character - rw.
    		•
  • imageurl - caracter - rw.
    		•
  • log - character - rw.
    		•
  • map - mapObj - rw.
    		•
  • maxscale - integer - rw.
    		•
  • maxtemplate - character - rw.
    		•
  • metadata - hashTableObj - rw.
    		•
  • minscale - integer - rw.
    		•
  • mintemplate - character - rw.
    		•
  • queryformat - character - rw.
    		•
  • template - character - rw.
    		•

    Methods: Method Description Returns Notes
    none


    intarray:

    Constructor:
    		 new mapscript::intarray(nelements) intarray->frompointer()

    Members:
  • none.
    		•

    Methods: Method Description Returns Notes
    cast() integer
    frompointer() intarray
    getitem(integer index) integer
    setitem(integer index, integer value) null



    hashTableObj:

    Constructor:
    		 new mapscript::hashTableObj() class->{metadata} layer->{metadata} map->{configoptions}
    web->{metadata}

    Members:
  • numitems - integer - ro.
    		•

    Methods: Method Description Returns Notes
    clear() null
    get(character key, character default) character default is optional.
    nextKey(character previous-key) character
    remove(character key) integer
    set(character key, character value) integer