SWIG MapScript API Reference — MapServer 8.6.1 documentation

SWIG MapScript API Reference — MapServer 8.6.1 documentation

MapScript Constants¶

Align¶

mapscript.MS_ALIGN_DEFAULT 0¶
mapscript.MS_ALIGN_LEFT 1¶

mapscript.MS_ALIGN_CENTER 2¶

mapscript.MS_ALIGN_RIGHT 3¶

Allocations¶

mapscript.MS_DEFAULT_LABEL_PRIORITY 1¶
mapscript.MS_LABEL_ALLOCSIZE 2¶
mapscript.MS_LABEL_FORCE_GROUP 2¶
mapscript.MS_STYLE_ALLOCSIZE 4¶
mapscript.MS_MAX_LABEL_FONTS 5¶

mapscript.MS_CLASS_ALLOCSIZE 8¶
mapscript.MS_MAXPATTERNLENGTH 10¶
mapscript.MS_MAX_LABEL_PRIORITY 10¶
mapscript.MS_POSITIONS_LENGTH 14¶
mapscript.MS_HASHSIZE 41¶

mapscript.ROUTINELENGTH 64¶

TODO Add documentation
mapscript.MS_DEFAULT_CGI_PARAMS 100¶
mapscript.SHX_BUFFER_PAGE 1024¶

TODO Add documentation
mapscript.MESSAGELENGTH 2048¶

TODO Add documentation

Comparison¶

mapscript.MS_TOKEN_COMPARISON_EQ 320¶
mapscript.MS_TOKEN_COMPARISON_NE 321¶
mapscript.MS_TOKEN_COMPARISON_GT 322¶
mapscript.MS_TOKEN_COMPARISON_LT 323¶
mapscript.MS_TOKEN_COMPARISON_LE 324¶
mapscript.MS_TOKEN_COMPARISON_GE 325¶
mapscript.MS_TOKEN_COMPARISON_IEQ 326¶

mapscript.MS_TOKEN_COMPARISON_RE 327¶
mapscript.MS_TOKEN_COMPARISON_IRE 328¶
mapscript.MS_TOKEN_COMPARISON_IN 329¶
mapscript.MS_TOKEN_COMPARISON_LIKE 330¶
mapscript.MS_TOKEN_COMPARISON_INTERSECTS 331¶
mapscript.MS_TOKEN_COMPARISON_DISJOINT 332¶
mapscript.MS_TOKEN_COMPARISON_TOUCHES 333¶

mapscript.MS_TOKEN_COMPARISON_OVERLAPS 334¶
mapscript.MS_TOKEN_COMPARISON_CROSSES 335¶
mapscript.MS_TOKEN_COMPARISON_WITHIN 336¶
mapscript.MS_TOKEN_COMPARISON_CONTAINS 337¶
mapscript.MS_TOKEN_COMPARISON_EQUALS 338¶
mapscript.MS_TOKEN_COMPARISON_BEYOND 339¶
mapscript.MS_TOKEN_COMPARISON_DWITHIN 340¶

Compop¶

mapscript.MS_COMPOP_CLEAR 0¶
mapscript.MS_COMPOP_SRC 1¶
mapscript.MS_COMPOP_DST 2¶
mapscript.MS_COMPOP_SRC_OVER 3¶
mapscript.MS_COMPOP_DST_OVER 4¶
mapscript.MS_COMPOP_SRC_IN 5¶
mapscript.MS_COMPOP_DST_IN 6¶
mapscript.MS_COMPOP_SRC_OUT 7¶
mapscript.MS_COMPOP_DST_OUT 8¶
mapscript.MS_COMPOP_SRC_ATOP 9¶
mapscript.MS_COMPOP_DST_ATOP 10¶

mapscript.MS_COMPOP_XOR 11¶
mapscript.MS_COMPOP_PLUS 12¶
mapscript.MS_COMPOP_MINUS 13¶
mapscript.MS_COMPOP_MULTIPLY 14¶
mapscript.MS_COMPOP_SCREEN 15¶
mapscript.MS_COMPOP_OVERLAY 16¶
mapscript.MS_COMPOP_DARKEN 17¶
mapscript.MS_COMPOP_LIGHTEN 18¶
mapscript.MS_COMPOP_COLOR_DODGE 19¶
mapscript.MS_COMPOP_COLOR_BURN 20¶
mapscript.MS_COMPOP_HARD_LIGHT 21¶

mapscript.MS_COMPOP_SOFT_LIGHT 22¶
mapscript.MS_COMPOP_DIFFERENCE 23¶
mapscript.MS_COMPOP_EXCLUSION 24¶
mapscript.MS_COMPOP_CONTRAST 25¶
mapscript.MS_COMPOP_INVERT 26¶
mapscript.MS_COMPOP_INVERT_RGB 27¶
mapscript.MS_COMPOP_HSL_HUE 28¶
mapscript.MS_COMPOP_HSL_LUMINOSITY 29¶
mapscript.MS_COMPOP_HSL_SATURATION 30¶
mapscript.MS_COMPOP_HSL_COLOR 31¶

Config¶

mapscript.MS_CONFIG_SECTION 3000¶
mapscript.MS_CONFIG_SECTION_ENV 3001¶

mapscript.MS_CONFIG_SECTION_MAPS 3002¶

mapscript.MS_CONFIG_SECTION_PLUGINS 3003¶

Connection¶

mapscript.MS_INLINE 0¶
mapscript.MS_TILED_SHAPEFILE 2¶
mapscript.MS_UNUSED_2 3¶
mapscript.MS_OGR 4¶
mapscript.MS_UNUSED_1 5¶
mapscript.MS_POSTGIS 6¶
mapscript.MS_WMS 7¶

mapscript.MS_ORACLESPATIAL 8¶
mapscript.MS_WFS 9¶
mapscript.MS_GRATICULE 10¶
mapscript.MS_MYSQL 11¶
mapscript.MS_RASTER 12¶
mapscript.MS_PLUGIN 13¶

mapscript.MS_UNION 14¶
mapscript.MS_UVRASTER 15¶
mapscript.MS_CONTOUR 16¶
mapscript.MS_KERNELDENSITY 17¶
mapscript.MS_IDW 18¶
mapscript.MS_FLATGEOBUF 19¶

Db Connection¶

mapscript.MS_DB_XBASE 0¶
mapscript.MS_DB_CSV 1¶

mapscript.MS_DB_MYSQL 2¶
mapscript.MS_DB_ORACLE 3¶

mapscript.MS_DB_POSTGRES 4¶

Dbf Fields¶

mapscript.FTString 0¶

TODO Add documentation
mapscript.FTInteger 1¶

TODO Add documentation

mapscript.FTDouble 2¶

TODO Add documentation

mapscript.FTInvalid 3¶

TODO Add documentation

Debug¶

mapscript.MS_DEBUGLEVEL_ERRORSONLY 0¶
mapscript.MS_DEBUGLEVEL_DEBUG 1¶
mapscript.MS_DEBUGLEVEL_TUNING 2¶

mapscript.MS_DEBUGLEVEL_V 3¶
mapscript.MS_DEBUGLEVEL_VV 4¶

mapscript.MS_DEBUGLEVEL_VVV 5¶
mapscript.MS_DEBUGLEVEL_DEVDEBUG 20¶

Error¶

mapscript.MS_NOERR 0¶
mapscript.MS_IOERR 1¶
mapscript.MS_MEMERR 2¶
mapscript.MS_TYPEERR 3¶
mapscript.MS_SYMERR 4¶
mapscript.MS_REGEXERR 5¶
mapscript.MS_TTFERR 6¶
mapscript.MS_DBFERR 7¶
mapscript.MS_IDENTERR 9¶
mapscript.MS_EOFERR 10¶
mapscript.MS_PROJERR 11¶
mapscript.MS_MISCERR 12¶
mapscript.MS_CGIERR 13¶
mapscript.MS_WEBERR 14¶
mapscript.MS_IMGERR 15¶

mapscript.MS_HASHERR 16¶
mapscript.MS_JOINERR 17¶
mapscript.MS_NOTFOUND 18¶
mapscript.MS_PARSEERR 20¶
mapscript.MS_UNUSEDERR 21¶
mapscript.MS_OGRERR 22¶
mapscript.MS_QUERYERR 23¶
mapscript.MS_WMSERR 24¶
mapscript.MS_WMSCONNERR 25¶
mapscript.MS_ORACLESPATIALERR 26¶
mapscript.MS_WFSERR 27¶
mapscript.MS_WFSCONNERR 28¶
mapscript.MS_MAPCONTEXTERR 29¶
mapscript.MS_HTTPERR 30¶
mapscript.MS_CHILDERR 31¶

mapscript.MS_WCSERR 32¶
mapscript.MS_GEOSERR 33¶
mapscript.MS_RECTERR 34¶
mapscript.MS_TIMEERR 35¶
mapscript.MS_GMLERR 36¶
mapscript.MS_SOSERR 37¶
mapscript.MS_NULLPARENTERR 38¶
mapscript.MS_AGGERR 39¶
mapscript.MS_OWSERR 40¶
mapscript.MS_OGLERR 41¶
mapscript.MS_RENDERERERR 42¶
mapscript.MS_V8ERR 43¶
mapscript.MS_OGCAPIERR 44¶
mapscript.MS_FGBERR 45¶
mapscript.MS_NUMERRORCODES 46¶

File¶

mapscript.MS_FILE_MAP 0¶

mapscript.MS_FILE_SYMBOL 1¶

Font Type¶

mapscript.MS_TRUETYPE 0¶

mapscript.MS_BITMAP 1¶

Function¶

mapscript.MS_TOKEN_FUNCTION_LENGTH 350¶
mapscript.MS_TOKEN_FUNCTION_TOSTRING 351¶
mapscript.MS_TOKEN_FUNCTION_COMMIFY 352¶
mapscript.MS_TOKEN_FUNCTION_AREA 353¶
mapscript.MS_TOKEN_FUNCTION_ROUND 354¶
mapscript.MS_TOKEN_FUNCTION_FROMTEXT 355¶
mapscript.MS_TOKEN_FUNCTION_BUFFER 356¶

mapscript.MS_TOKEN_FUNCTION_DIFFERENCE 357¶
mapscript.MS_TOKEN_FUNCTION_SIMPLIFY 358¶
mapscript.MS_TOKEN_FUNCTION_SIMPLIFYPT 359¶
mapscript.MS_TOKEN_FUNCTION_GENERALIZE 360¶
mapscript.MS_TOKEN_FUNCTION_SMOOTHSIA 361¶
mapscript.MS_TOKEN_FUNCTION_CENTERLINE 362¶
mapscript.MS_TOKEN_FUNCTION_DENSIFY 363¶

mapscript.MS_TOKEN_FUNCTION_OUTER 364¶
mapscript.MS_TOKEN_FUNCTION_INNER 365¶
mapscript.MS_TOKEN_FUNCTION_JAVASCRIPT 366¶
mapscript.MS_TOKEN_FUNCTION_UPPER 367¶
mapscript.MS_TOKEN_FUNCTION_LOWER 368¶
mapscript.MS_TOKEN_FUNCTION_INITCAP 369¶
mapscript.MS_TOKEN_FUNCTION_FIRSTCAP 370¶

Geos¶

mapscript.MS_GEOS_EQUALS 0¶
mapscript.MS_GEOS_DISJOINT 1¶
mapscript.MS_GEOS_TOUCHES 2¶
mapscript.MS_GEOS_OVERLAPS 3¶

mapscript.MS_GEOS_CROSSES 4¶
mapscript.MS_GEOS_INTERSECTS 5¶
mapscript.MS_GEOS_WITHIN 6¶

mapscript.MS_GEOS_CONTAINS 7¶
mapscript.MS_GEOS_BEYOND 8¶
mapscript.MS_GEOS_DWITHIN 9¶

Image Mode¶

mapscript.MS_IMAGEMODE_PC256 0¶
mapscript.MS_IMAGEMODE_RGB 1¶
mapscript.MS_IMAGEMODE_RGBA 2¶

mapscript.MS_IMAGEMODE_INT16 3¶
mapscript.MS_IMAGEMODE_FLOAT32 4¶
mapscript.MS_IMAGEMODE_BYTE 5¶

mapscript.MS_IMAGEMODE_FEATURE 6¶
mapscript.MS_IMAGEMODE_NULL 7¶

Join¶

mapscript.MS_JOIN_ONE_TO_ONE 0¶

mapscript.MS_JOIN_ONE_TO_MANY 1¶

Label Binding¶

mapscript.MS_LABEL_BINDING_SIZE 0¶
mapscript.MS_LABEL_BINDING_ANGLE 1¶
mapscript.MS_LABEL_BINDING_COLOR 2¶
mapscript.MS_LABEL_BINDING_OUTLINECOLOR 3¶
mapscript.MS_LABEL_BINDING_FONT 4¶

mapscript.MS_LABEL_BINDING_PRIORITY 5¶
mapscript.MS_LABEL_BINDING_POSITION 6¶
mapscript.MS_LABEL_BINDING_SHADOWSIZEX 7¶
mapscript.MS_LABEL_BINDING_SHADOWSIZEY 8¶

mapscript.MS_LABEL_BINDING_OFFSET_X 9¶
mapscript.MS_LABEL_BINDING_OFFSET_Y 10¶
mapscript.MS_LABEL_BINDING_ALIGN 11¶
mapscript.MS_LABEL_BINDING_LENGTH 12¶

Label Offset¶

mapscript.MS_LABEL_PERPENDICULAR_OFFSET -99¶

mapscript.MS_LABEL_PERPENDICULAR_TOP_OFFSET 99¶

Label Size¶

mapscript.MS_TINY 5¶
mapscript.MS_SMALL 7¶

mapscript.MS_MEDIUM 10¶
mapscript.MS_LARGE 13¶

mapscript.MS_GIANT 16¶

Layer¶

mapscript.MS_LAYER_POINT 0¶
mapscript.MS_LAYER_LINE 1¶
mapscript.MS_LAYER_POLYGON 2¶
mapscript.MS_LAYER_RASTER 3¶

mapscript.MS_LAYER_ANNOTATION 4¶
mapscript.MS_LAYER_QUERY 5¶
mapscript.MS_LAYER_CIRCLE 6¶

mapscript.MS_LAYER_TILEINDEX 7¶
mapscript.MS_LAYER_CHART 8¶
mapscript.MS_LAYER_ALLOCSIZE 64¶

Legend¶

mapscript.MS_LEGEND_KEYSPACING_MIN 0¶
mapscript.MS_LEGEND_KEYSIZE_MIN 5¶

mapscript.MS_LEGEND_KEYSPACING_MAX 50¶

mapscript.MS_LEGEND_KEYSIZE_MAX 200¶

Limiters¶

mapscript.MS_IMAGECACHESIZE 6¶

mapscript.MS_MAXVECTORPOINTS 100¶

Line Join¶

mapscript.MS_CJC_NONE 0¶
mapscript.MS_CJC_BEVEL 1¶
mapscript.MS_CJC_BUTT 2¶

mapscript.MS_CJC_DEFAULT_JOIN_MAXSIZE 3¶
mapscript.MS_CJC_MITER 3¶
mapscript.MS_CJC_ROUND 4¶

mapscript.MS_CJC_SQUARE 5¶
mapscript.MS_CJC_TRIANGLE 6¶

Logical Control¶

mapscript.MS_UNKNOWN -1¶
mapscript.MS_FALSE 0¶
mapscript.MS_NO 0¶
mapscript.MS_OFF 0¶

mapscript.MS_ON 1¶
mapscript.MS_TRUE 1¶
mapscript.MS_YES 1¶

mapscript.MS_DEFAULT 2¶
mapscript.MS_EMBED 3¶
mapscript.MS_DELETE 4¶

Measure Shape¶

mapscript.MS_SHP_POINTZ 11¶
mapscript.MS_SHP_ARCZ 13¶
mapscript.MS_SHP_POLYGONZ 15¶

mapscript.MS_SHP_MULTIPOINTZ 18¶
mapscript.MS_SHPERR 19¶
mapscript.MS_SHP_POINTM 21¶

mapscript.MS_SHP_ARCM 23¶
mapscript.MS_SHP_POLYGONM 25¶
mapscript.MS_SHP_MULTIPOINTM 28¶

Missing¶

mapscript.MS_NUM_CHECK_NONE 0¶
mapscript.MS_NUM_CHECK_RANGE 1¶

mapscript.MS_NUM_CHECK_GT 2¶
mapscript.MS_NUM_CHECK_GTE 3¶

mapscript.MS_RESOLUTION_MIN 10¶
mapscript.MS_RESOLUTION_MAX 1000¶

Parse¶

mapscript.MS_PARSE_TYPE_BOOLEAN 0¶
mapscript.MS_PARSE_TYPE_STRING 1¶

mapscript.MS_PARSE_TYPE_SHAPE 2¶

mapscript.MS_PARSE_TYPE_SLD 3¶

Position¶

mapscript.MS_UL 101¶
mapscript.MS_LR 102¶
mapscript.MS_UR 103¶
mapscript.MS_LL 104¶
mapscript.MS_CR 105¶

mapscript.MS_CL 106¶
mapscript.MS_UC 107¶
mapscript.MS_LC 108¶
mapscript.MS_CC 109¶
mapscript.MS_AUTO 110¶

mapscript.MS_XY 111¶
mapscript.MS_NONE 112¶
mapscript.MS_AUTO2 113¶
mapscript.MS_FOLLOW 114¶

Projections¶

mapscript.wkp_none 0¶

TODO Add documentation

mapscript.wkp_lonlat 1¶

TODO Add documentation

mapscript.wkp_gmerc 2¶

TODO Add documentation

Query Mode¶

mapscript.MS_NORMAL 0¶

mapscript.MS_HILITE 1¶

mapscript.MS_SELECTED 2¶

Query Type¶

mapscript.MS_QUERY_IS_NULL 0¶
mapscript.MS_QUERY_SINGLE 0¶
mapscript.MS_SINGLE 0¶
mapscript.MS_MULTIPLE 1¶

mapscript.MS_QUERY_BY_POINT 1¶
mapscript.MS_QUERY_MULTIPLE 1¶
mapscript.MS_QUERY_BY_RECT 2¶
mapscript.MS_QUERY_BY_SHAPE 3¶

mapscript.MS_QUERY_BY_ATTRIBUTE 4¶
mapscript.MS_QUERY_BY_INDEX 5¶
mapscript.MS_QUERY_BY_FILTER 6¶

Render¶

mapscript.MS_RENDER_WITH_SWF 2¶
mapscript.MS_RENDER_WITH_RAWDATA 3¶
mapscript.MS_RENDER_WITH_IMAGEMAP 5¶
mapscript.MS_RENDER_WITH_TEMPLATE 8¶
mapscript.MS_RENDER_WITH_OGR 16¶

mapscript.MS_RENDER_WITH_PLUGIN 100¶
mapscript.MS_RENDER_WITH_CAIRO_RASTER 101¶
mapscript.MS_RENDER_WITH_CAIRO_PDF 102¶
mapscript.MS_RENDER_WITH_CAIRO_SVG 103¶
mapscript.MS_RENDER_WITH_OGL 104¶

mapscript.MS_RENDER_WITH_AGG 105¶
mapscript.MS_RENDER_WITH_KML 106¶
mapscript.MS_RENDER_WITH_UTFGRID 107¶
mapscript.MS_RENDER_WITH_MVT 108¶

Render Mode¶

mapscript.MS_FIRST_MATCHING_CLASS 0¶

mapscript.MS_ALL_MATCHING_CLASSES 1¶

Request Type¶

mapscript.MS_GET_REQUEST 0¶

mapscript.MS_POST_REQUEST 1¶

Return Codes¶

mapscript.MS_SUCCESS 0¶

mapscript.MS_FAILURE 1¶

mapscript.MS_DONE 2¶

Scalebar¶

mapscript.MS_SCALEBAR_OFFSET_MIN -50¶
mapscript.MS_SCALEBAR_INTERVALS_MIN 1¶
mapscript.MS_SCALEBAR_HEIGHT_MIN 2¶

mapscript.MS_SCALEBAR_WIDTH_MIN 5¶
mapscript.MS_SCALEBAR_OFFSET_MAX 50¶
mapscript.MS_SCALEBAR_HEIGHT_MAX 100¶

mapscript.MS_SCALEBAR_INTERVALS_MAX 100¶
mapscript.MS_SCALEBAR_WIDTH_MAX 1000¶

Shapefile¶

mapscript.MS_SHAPEFILE 1¶
mapscript.MS_SHAPEFILE_POINT 1¶

mapscript.MS_SHAPEFILE_ARC 3¶
mapscript.MS_SHAPEFILE_POLYGON 5¶

mapscript.MS_SHAPEFILE_MULTIPOINT 8¶

Shape Type¶

mapscript.MS_SHAPE_POINT 0¶
mapscript.MS_SHAPE_LINE 1¶

mapscript.MS_SHAPE_POLYGON 2¶

mapscript.MS_SHAPE_NULL 3¶

Style Binding¶

mapscript.MS_STYLE_BINDING_SIZE 0¶
mapscript.MS_STYLE_BINDING_WIDTH 1¶
mapscript.MS_STYLE_BINDING_ANGLE 2¶
mapscript.MS_STYLE_BINDING_COLOR 3¶
mapscript.MS_STYLE_BINDING_OUTLINECOLOR 4¶

mapscript.MS_STYLE_BINDING_SYMBOL 5¶
mapscript.MS_STYLE_BINDING_OUTLINEWIDTH 6¶
mapscript.MS_STYLE_BINDING_OPACITY 7¶
mapscript.MS_STYLE_BINDING_OFFSET_X 8¶

mapscript.MS_STYLE_BINDING_OFFSET_Y 9¶
mapscript.MS_STYLE_BINDING_POLAROFFSET_PIXEL 10¶
mapscript.MS_STYLE_BINDING_POLAROFFSET_ANGLE 11¶
mapscript.MS_STYLE_BINDING_LENGTH 12¶

Style Offset¶

mapscript.MS_STYLE_DOUBLE_SIDED_OFFSET -999¶

mapscript.MS_STYLE_SINGLE_SIDED_OFFSET -99¶

Symbol¶

mapscript.MS_SYMBOL_ALLOCSIZE 64¶
mapscript.MS_SYMBOL_SIMPLE 1000¶
mapscript.MS_SYMBOL_VECTOR 1001¶

mapscript.MS_SYMBOL_ELLIPSE 1002¶
mapscript.MS_SYMBOL_PIXMAP 1003¶
mapscript.MS_SYMBOL_TRUETYPE 1004¶

mapscript.MS_SYMBOL_HATCH 1005¶
mapscript.MS_SYMBOL_SVG 1006¶

Token Binding¶

mapscript.MS_TOKEN_BINDING_DOUBLE 380¶
mapscript.MS_TOKEN_BINDING_INTEGER 381¶
mapscript.MS_TOKEN_BINDING_STRING 382¶

mapscript.MS_TOKEN_BINDING_TIME 383¶
mapscript.MS_TOKEN_BINDING_SHAPE 384¶

mapscript.MS_TOKEN_BINDING_MAP_CELLSIZE 385¶
mapscript.MS_TOKEN_BINDING_DATA_CELLSIZE 386¶

Token Literal¶

mapscript.MS_TOKEN_LITERAL_NUMBER 310¶
mapscript.MS_TOKEN_LITERAL_STRING 311¶

mapscript.MS_TOKEN_LITERAL_TIME 312¶
mapscript.MS_TOKEN_LITERAL_SHAPE 313¶

mapscript.MS_TOKEN_LITERAL_BOOLEAN 314¶

Token Logical¶

mapscript.MS_TOKEN_LOGICAL_AND 300¶

mapscript.MS_TOKEN_LOGICAL_OR 301¶

mapscript.MS_TOKEN_LOGICAL_NOT 302¶

Transform¶

mapscript.MS_TRANSFORM_NONE 0¶
mapscript.MS_TRANSFORM_ROUND 1¶

mapscript.MS_TRANSFORM_SNAPTOGRID 2¶
mapscript.MS_TRANSFORM_FULLRESOLUTION 3¶

mapscript.MS_TRANSFORM_SIMPLIFY 4¶

Units¶

mapscript.MS_INHERIT -1¶
mapscript.MS_INCHES 0¶
mapscript.MS_FEET 1¶
mapscript.MS_MILES 2¶

mapscript.MS_METERS 3¶
mapscript.MS_KILOMETERS 4¶
mapscript.MS_DD 5¶

mapscript.MS_PIXELS 6¶
mapscript.MS_PERCENTAGES 7¶
mapscript.MS_NAUTICALMILES 8¶

Version¶

mapscript.MS_VERSION_MINOR 0¶
mapscript.MS_VERSION_REV 1¶

mapscript.MS_VERSION_MAJOR 8¶

mapscript.MS_VERSION_NUM 80001¶