Swig MapScript API引用

作者

肖恩吉利斯

作者

史蒂夫·莱姆

联系

明尼苏达州第纳尔的史蒂夫·莱姆

作者

弗兰克·沃默丹

联系

Pobox.com上的Warmerdam

作者

乌姆贝托·尼科莱蒂

联系

gmail.com上的umberto.nicoletti

作者

塔玛斯塞克勒斯

联系

gmail.com上的szekerest

作者

丹尼尔·莫里塞特

联系

位于mapgears.com的dmorisette

作者

杰夫麦克纳

联系

jmckenna在gatewaygeomatics.com

作者

赛斯·吉文

联系

Sethg在gegraph ika.co.uk网站上

最后更新

2021-05-22

介绍

本文档针对由SWIG生成的MapServer的MapScrip接口。

为了使文档尽可能不可知，我们引用了以下类型：int、浮点数和字符串。目前还没有返回数组或序列或接受数组或序列参数的MapScript方法。

我们将使用swig术语 immutable 以指示属性的值是只读的。

请注意，由于MapScript的生成方式，许多令人困惑、无意义、甚至危险的属性可能会被对象公开。

附录

以下附录描述了特定于语言的扩展

python mapscript附录

备注

自MapServer 7.4.0发布以来，SWIG API中包含了php7支持。

mapscript类

DBFInfo \()
OWSRequest \()
classObj \([layer] )
clusterObj \()
colorObj \([red, green, blue, alpha] )
errorObj \()
fontSetObj \()
hashTableObj \()
imageObj \(*参数)
labelCacheMemberObj \()
labelCacheObj \()
labelCacheSlotObj \()
labelLeaderObj \()
labelObj \()
layerObj \([map] )
legendObj \()
lineObj \()
mapObj \(*参数)
markerCacheMemberObj \()
outputFormatObj \(驱动程序，名称)
pointObj \([x, y, z, m] )
projectionObj \(项目4)
queryMapObj \()
rectObj \([minx, miny, maxx, maxy, imageunits] )
referenceMapObj \()
resultCacheObj \()
resultObj \(形状索引)
scaleTokenEntryObj \()
scaleTokenObj \()
scalebarObj \()
shapeObj \(类型)
shapefileObj \(文件名[, type] )
styleObj \([parent_class] )
symbolObj \(符号名，图像文件)
symbolSetObj \(符号文件)
webObj \()

mapscript函数

mapscript.fromstring \(数据[, mappath] )	从映射文件字符串创建映射对象。
mapscript.msCleanup \()
mapscript.msConnPoolCloseUnreferenced \()	通过时不时地调用msConnPoolCloseUnference可以避免某些内存泄漏。
mapscript.msFreeImage \(img)
mapscript.msGetErrorObj \()
mapscript.msGetErrorString \(分隔符)
mapscript.msGetVersion \()
mapscript.msGetVersionInt \()
mapscript.msIO_getAndStripStdoutBufferMimeHeaders \()
mapscript.msIO_getStdoutBufferBytes \()
mapscript.msIO_getStdoutBufferString \()
mapscript.msIO_installStdinFromBuffer \()
mapscript.msIO_installStdoutToBuffer \()
mapscript.msIO_resetHandlers \()
mapscript.msIO_stripStdoutBufferContentHeaders \()
mapscript.msIO_stripStdoutBufferContentType \()
mapscript.msLoadMapFromString \(缓冲区，...)
mapscript.msResetErrorList \()
mapscript.msSaveImage \(map，img，文件名)
mapscript.msSetup \()
mapscript.shapeObj_fromWKT \(wkt)
mapscript.value \(数据[, mappath] )	从映射文件字符串创建映射对象。

mapscript常量

对齐

mapscript.MS_ALIGN_DEFAULT 0 mapscript.MS_ALIGN_LEFT 1

mapscript.MS_ALIGN_CENTER 2

mapscript.MS_ALIGN_RIGHT 3

分配

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 添加文档 mapscript.MS_DEFAULT_CGI_PARAMS 100 mapscript.SHX_BUFFER_PAGE 1024 TODO 添加文档 mapscript.MESSAGELENGTH 2048 TODO 添加文档

比较

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

康普普

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_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_DB_XBASE 0 mapscript.MS_DB_CSV 1

mapscript.MS_DB_MYSQL 2 mapscript.MS_DB_ORACLE 3

mapscript.MS_DB_POSTGRES 4

DBF字段

mapscript.FTString 0 TODO 添加文档 mapscript.FTInteger 1 TODO 添加文档

mapscript.FTDouble 2 TODO 添加文档

mapscript.FTInvalid 3 TODO 添加文档

调试

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

误差率

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_NUMERRORCODES 44

档案

mapscript.MS_FILE_MAP 0

mapscript.MS_FILE_SYMBOL 1

字体类型

mapscript.MS_TRUETYPE 0

mapscript.MS_BITMAP 1

功能

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_JAVASCRIPT 362 mapscript.MS_TOKEN_FUNCTION_UPPER 363 mapscript.MS_TOKEN_FUNCTION_LOWER 364 mapscript.MS_TOKEN_FUNCTION_INITCAP 365 mapscript.MS_TOKEN_FUNCTION_FIRSTCAP 366

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

图像模式

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

会合

mapscript.MS_JOIN_ONE_TO_ONE 0

mapscript.MS_JOIN_ONE_TO_MANY 1

标签绑定

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

标签偏移

mapscript.MS_LABEL_PERPENDICULAR_OFFSET -99

mapscript.MS_LABEL_PERPENDICULAR_TOP_OFFSET 99

标签大小

mapscript.MS_TINY 5 mapscript.MS_SMALL 7

mapscript.MS_MEDIUM 10 mapscript.MS_LARGE 13

mapscript.MS_GIANT 16

图层

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

限定检索

mapscript.MS_IMAGECACHESIZE 6

mapscript.MS_MAXVECTORPOINTS 100

线连接

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

逻辑控制

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

测量形状

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

解析

mapscript.MS_PARSE_TYPE_BOOLEAN 0 mapscript.MS_PARSE_TYPE_STRING 1

mapscript.MS_PARSE_TYPE_SHAPE 2

职位

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

推算

mapscript.wkp_none 0 TODO 添加文档

mapscript.wkp_lonlat 1 TODO 添加文档

mapscript.wkp_gmerc 2 TODO 添加文档

查询模式

mapscript.MS_NORMAL 0

mapscript.MS_HILITE 1

mapscript.MS_SELECTED 2

查询类型

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

渲染

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

渲染模式

mapscript.MS_FIRST_MATCHING_CLASS 0

mapscript.MS_ALL_MATCHING_CLASSES 1

请求类型

mapscript.MS_GET_REQUEST 0

mapscript.MS_POST_REQUEST 1

返回码

mapscript.MS_SUCCESS 0

mapscript.MS_FAILURE 1

mapscript.MS_DONE 2

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

形状类型

mapscript.MS_SHAPE_POINT 0 mapscript.MS_SHAPE_LINE 1

mapscript.MS_SHAPE_POLYGON 2

mapscript.MS_SHAPE_NULL 3

样式绑定

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

样式偏移

mapscript.MS_STYLE_DOUBLE_SIDED_OFFSET -999

mapscript.MS_STYLE_SINGLE_SIDED_OFFSET -99

符号

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

令牌绑定

mapscript.MS_TOKEN_BINDING_DOUBLE 370 mapscript.MS_TOKEN_BINDING_INTEGER 371 mapscript.MS_TOKEN_BINDING_STRING 372

mapscript.MS_TOKEN_BINDING_TIME 373 mapscript.MS_TOKEN_BINDING_SHAPE 374

mapscript.MS_TOKEN_BINDING_MAP_CELLSIZE 375 mapscript.MS_TOKEN_BINDING_DATA_CELLSIZE 376

标记文字

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

令牌逻辑

mapscript.MS_TOKEN_LOGICAL_AND 300

mapscript.MS_TOKEN_LOGICAL_OR 301

mapscript.MS_TOKEN_LOGICAL_NOT 302

转型

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

单位

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

版本

mapscript.MS_VERSION_REV 0 mapscript.MS_VERSION_MAJOR 7

mapscript.MS_VERSION_MINOR 7

mapscript.MS_VERSION_NUM 70700