Swig MapScript API引用¶
- 作者
肖恩吉利斯
- 作者
史蒂夫·莱姆
- 接触
明尼苏达州第纳尔的史蒂夫·莱姆
- 作者
Frank Warmerdam
- 接触
可在 Pobox.com 了解相关信息
- 作者
乌姆贝托·尼科莱蒂
- 接触
gmail.com上的umberto.nicoletti
- 作者
塔玛斯塞克勒斯
- 接触
gmail.com上的szekerest
- 作者
丹尼尔·莫里塞特
- 接触
位于mapgears.com的dmorisette
- 作者
Jeff McKenna
- 接触
jmckenna在gatewaygeomatics.com
- 最后更新
2019-11-21
注解
自MapServer 7.4.0发布以来,SWIG API中包含了php7支持。
目录
介绍¶
这是由swig生成的mapscript接口到mapserver的语言不可知文档。本文档旨在供开发人员使用,并作为MDP DocBook格式的更广泛、语言特定文档的编写者参考。
文档元素¶
课程将按照下面概述的方式按字母顺序记录。属性和方法将被格式化为定义列表,属性或方法作为项,类型或返回类型作为分类器,以及简洁的描述。为了使文档尽可能不可知,我们引用了以下类型:int、float和string。还没有返回数组或序列或接受数组或序列参数的mapscript方法。
我们将使用swig术语 immutable 以指示属性的值是只读的。
mapscript常量¶
常数在每组中按字母顺序排列。
地图单位¶
名字 |
类型 |
MS_DD |
整数 |
MS_FEET |
整数 |
MS_INCHES |
整数 |
MS_METERS |
整数 |
MS_MILES |
整数 |
MS_NAUTICALMILES |
整数 |
MS_PIXELS |
整数 |
层类型¶
名字 |
类型 |
ms_layer_注释(自6.2起已弃用) |
整数 |
MS_LAYER_CIRCLE |
整数 |
MS_LAYER_LINE |
整数 |
MS_LAYER_POINT |
整数 |
MS_LAYER_POLYGON |
整数 |
MS_LAYER_QUERY |
整数 |
MS_LAYER_RASTER |
整数 |
MS_LAYER_TILEINDEX |
整数 |
标签位置¶
名字 |
类型 |
MS_AUTO |
整数 |
MS_CC |
整数 |
MS_CL |
整数 |
MS_CR |
整数 |
MS_LC |
整数 |
MS_LL |
整数 |
MS_LR |
整数 |
MS_UC |
整数 |
MS_UL |
整数 |
MS_UR |
整数 |
标签大小(仅限位图)¶
名字 |
类型 |
MS_GIANT |
整数 |
MS_LARGE |
整数 |
MS_MEDIUM |
整数 |
MS_SMALL |
整数 |
MS_TINY |
整数 |
整形器类型¶
名字 |
类型 |
MS_SHAPEFILE_ARC |
整数 |
MS_SHAPEFILE_MULTIPOINT |
整数 |
MS_SHAPEFILE_POINT |
整数 |
MS_SHAPEFILE_POLYGON |
整数 |
连接类型¶
名字 |
类型 |
MS_GRATICULE |
整数 |
MS_INLINE |
整数 |
MS_MYGIS |
整数 |
MS_OGR |
整数 |
MS_ORACLESPATIAL |
整数 |
MS_POSTGIS |
整数 |
MS_RASTER |
整数 |
MS_SDE |
整数 |
MS_SHAPEFILE |
整数 |
MS_TILED_SHAPEFILE |
整数 |
MS_WFS |
整数 |
MS_WMS |
整数 |
线条连接类型(用于渲染)¶
名字 |
类型 |
MS_CJC_BEVEL |
整数 |
MS_CJC_BUTT |
整数 |
MS_CJC_MITER |
整数 |
MS_CJC_NONE |
整数 |
MS_CJC_ROUND |
整数 |
MS_CJC_SQUARE |
整数 |
MS_CJC_TRIANGLE |
整数 |
图像类型¶
名字 |
类型 |
GD/GIF |
整数 |
GD/JPEG |
整数 |
GD/PNG |
整数 |
GD/PNG24 |
整数 |
Gd/WBMP |
整数 |
GDAL/GTIFF |
整数 |
图像映射 |
整数 |
整数 |
|
SWF |
整数 |
图像模式¶
名字 |
类型 |
MS_GD_ALPHA |
整数 |
MS_IMAGEMODE_BYTE |
整数 |
MS_IMAGEMODE_FLOAT32 |
整数 |
MS_IMAGEMODE_INT16 |
整数 |
MS_IMAGEMODE_NULL |
整数 |
MS_IMAGEMODE_PC256 |
整数 |
MS_IMAGEMODE_RGB |
整数 |
MS_IMAGEMODE_RGBA |
整数 |
MS_NOOVERRIDE |
整数 |
符号类型¶
名字 |
类型 |
MS_SYMBOL_ELLIPSE |
整数 |
MS_SYMBOL_PIXMAP |
整数 |
MS_SYMBOL_SIMPLE |
整数 |
MS_SYMBOL_TRUETYPE |
整数 |
MS_SYMBOL_VECTOR |
整数 |
错误返回代码¶
名字 |
类型 |
MESSAGELENGTH |
长的 |
MS_CGIERR |
长的 |
MS_CHILDERR |
长的 |
MS_DBFERR |
长的 |
MS_EOFERR |
长的 |
MS_GDERR |
长的 |
MS_HASHERR |
长的 |
MS_HTTPERR |
长的 |
MS_IDENTERR |
长的 |
MS_IMGERR |
长的 |
MS_IOERR |
长的 |
MS_JOINERR |
长的 |
MS_MAPCONTEXTERR |
长的 |
MS_MEMERR |
长的 |
MS_MISCERR |
长的 |
MS_NOERR |
长的 |
MS_NOTFOUND |
长的 |
MS_NUMERRORCODES |
长的 |
MS_OGRERR |
长的 |
MS_ORACLESPATIALERR |
长的 |
MS_PARSEERR |
长的 |
MS_PROJERR |
长的 |
MS_QUERYERR |
长的 |
MS_REGEXERR |
长的 |
MS_SDEERR |
长的 |
MS_SHPERR |
长的 |
MS_SYMERR |
长的 |
MS_TTFERR |
长的 |
MS_TYPEERR |
长的 |
MS_WCSERR |
长的 |
MS_WEBERR |
长的 |
MS_WFSCONNERR |
长的 |
MS_WFSERR |
长的 |
MS_WMSCONNERR |
长的 |
MS_WMSERR |
长的 |
ROUTINELENGTH |
长的 |
mapscript函数¶
- MSCLANUP()无效
mscleanup()尝试恢复由mapserver代码和相关库分配的所有动态分配的资源。它主要用于脚本的最终清理,这些脚本需要进行内存泄漏测试以消除一次性分配的“噪音”。生产代码通常不应使用它。
- MSGETVIEWN()一串
返回一个字符串,该字符串包含MapServer版本信息以及有关内置哪些可选组件的详细信息。与“MAPSERV-V”生成的报告相同。
- msgetversionInt()中的利息
以整数(x*10000+y*100+z)形式返回MapServer版本号(x.y.z)。(v5.0中新增)例如v5.4.3将返回50403。
- msio_getstdobufferbytes()中的二进制数据
将当前stdout缓冲区内容提取为二进制缓冲区。此缓冲区的确切形式将由MaScript语言(如Python中的字符串、爪哇中的字节[]数组和Cyperi中未处理的Perl)而变化。
- msio_GetStdOutBufferString()。一串
以字符串形式获取当前stdout缓冲区内容。此方法不清除缓冲区。
- msio_安装stdinfrombuffer()无效
安装一个MapServer IO处理程序,引导将来的stdin读取(即请求后捕获)来自缓冲区。
- msio_安装stdouttobuffer()无效
安装一个MapServer IO处理程序,将未来的stdout输出定向到内存缓冲区。
- msio ou resethandler()号无效
重置默认stdin和stdout处理程序,而不是基于“缓冲区”的处理程序。
- msio_stripstdobufferContentHeaders():无效
从stdout缓冲区中除去所有内容-* 头(如果有)。
- msio_条stdobufferContentType())一串
从stdout缓冲区中除去content-type头(如果有),如果找到content-type,则返回(否则为null/none/etc)。
- msreseterorlist()。无效
清除当前错误堆栈。
mapscript类¶
类对象¶
ClassObj的一个实例与layerObj的一个实例相关联:
+-------+ 0..* 1 +-------+
| Class | <--------> | Layer |
+-------+ +-------+
classobj的其他重要关联是与styleobj_uuj、labelobj_uu和hashtableobj_uuj:
+-------+ 1 0..* +-------+
| Class | ---------> | Style |
+-------+ +-------+
+-------+ 1 0..* +-------+
| Class | ---------> | Label |
+-------+ +-------+
+-------+ 1 1 +-----------+
| Class | ---------> | HashTable |
+-------+ | -- |
| metadata |
+-----------+
从4.1开始支持多个类样式,从6.2开始支持多个类标签。有关使用多个类样式的详细信息,请参见StyleObj_u部分。
Classobj属性¶
- 调试利息
MS_TRUE 或 MS_FALSE
- 关键图像一串
TODO 不确定此属性的用途
- 标签:labelobj_uuu不可变labelobj不可变
类标签的定义。已删除(6.2)-请改用addlabel、getlabel和removelabel。
- 层:层对象不可变layerobj不可变
对父层的引用
- 最大刻度浮动
绘制类的最小比例
- 元数据:hashtableobj_uu不可变hashtableobj不可变
类元数据哈希表。
- 最小尺度浮动
绘制类的最大比例
- 名称一串
层内唯一
- 数字标记利息
类的标签数。
6.2 新版功能.
- 数字利息
类的样式数。在将来,可能是4.4版本中,将生成此属性 不变的.
- 地位利息
MS_ON 还是 MS_OFF 。 是否绘制此类的特征。
- 模板一串
查询模板
- 标题一串
用于图例标记的文本
- 类型利息
其父层的层类型
Classobj方法¶
- 新classobj([layerobj_u parent_layer=null])类对象
在 parent_layer. 通过省略单个构造函数参数,可以在父层上下文之外创建类。
- 添加标签(labelobj)利息
将labelobj添加到classobj并在labels数组中返回其索引。
6.2 新版功能.
- 克隆()类对象
返回没有父层的类的独立副本。
- 转换字符串()一串
将对象保存到字符串。为UpdateFromString提供反转选项。
6.4 新版功能.
- CreateLegendicon(地图,图层,图层,int宽度,int高度)_图像对象
绘制并返回新的图例图标。
- DrawLegendicon(地图、图层、图层、int宽度、int高度、图像、int dstx、int dsty)利息
将图例图标绘制到 image 在 dstx, dsty. 返回ms-success或ms-failure。
- GetExpressionString()。一串
返回表达式的字符串表示形式,该表达式用适合表达式类型的引号字符括起来。
- 获取第一个元数据键()一串
返回元数据哈希表中的第一个键。使用getNextMetadataKey(),在键上提供不透明的迭代器。
注解
getFirstMetadataKey()、getMetadata()和getNextMetadataKey()已弃用,将在未来版本中删除。替换为直接元数据访问,请参见hashtableobj_uuu。
- GetLabel(int索引)_拉贝洛夫
返回对labelobj的引用,位于 index 在标签数组中。
有关多个类标签的详细信息,请参阅labelobj_u部分。
6.2 新版功能.
- GetMetadata(字符串键)一串
返回位于的ClassObj元数据的值 key.
注解
getFirstMetadataKey()、getMetadata()和getNextMetadataKey()已弃用,将在未来版本中删除。替换为直接元数据访问,请参见hashtableobj_uuu。
- GetNextMetadataKey(字符串LastKey)一串
返回元数据哈希表中的下一个键,如果 lastkey 是最后一个有效密钥。如果 lastkey 为空,返回元数据哈希表的第一个键。
注解
getFirstMetadataKey()、getMetadata()和getNextMetadataKey()已弃用,将在未来版本中删除。替换为直接元数据访问,请参见hashtableobj_uuu。
- GetStyle(int索引)_样式对象
返回对StyleObj的引用 index 在样式数组中。
有关多个类样式的更多详细信息,请参见StyleObj_u部分。
- 获取文本字符串()一串
返回一个字符串表示形式,该文本包含在与文本表达式类型(逻辑字符串或简单字符串)相应的引号字符中。
- insertStyle(styleobj_u style[,int index=-1])利息
插入一个 copy 属于 style 到索引处的样式数组中 指数. 默认值为-1,或数组的结尾。返回插入样式的索引。
- moveStyleDown(int索引)利息
交换StyleObj index 带样式obj index + 1。
- moveStyleup(int索引)利息
交换StyleObj index 带样式obj index - 1。
- removelabel(int索引)_拉贝洛夫
移除位于的Labelobj index 从标签数组返回对labelobj的引用。numLabels将递减,数组将更新。
6.2 新版功能.
- 删除样式(int index)_样式对象
删除处的StyleObj index 从样式数组中返回一个副本。
- setExpression(字符串表达式)利息
设置表达式字符串的位置 expression 是MapServer正则、逻辑或字符串表达式。返回ms-success或ms-failuire。
- setmetadata(字符串键、字符串值)利息
插入 value 进入Classobj元数据 key. 返回ms-success或ms-failure。
注解
setmetadata()已弃用,将在将来的版本中删除。替换为直接元数据访问,请参见hashtableobj_uuu。
- settext(字符串文本)利息
设置文本字符串的位置 text 是MapServer文本表达式。返回ms-success或ms-failuire。
注解
旧版本的mapscript(4.8之前)采用了一个未记录的settext()方法,该方法要求将layerobj作为第一个参数传递。那个论点完全是假的,已经被删除了。
色度Objo¶
自4.0版本以来,mapserver colors就是colorobj的实例。colorobj可以是一个单独的对象或其他对象的属性,并且没有其他关联。
颜色对象属性¶
- 阿尔法利息
范围内颜色的alpha(不透明度)分量[0-255]
- 蓝色利息
范围内颜色的蓝色成分[0-255]
- 绿色利息
范围内颜色的绿色成分[0-255]
- 红色利息
范围内颜色的红色成分[0-255]
颜色对象方法¶
- 新颜色obj([int red=0,int green=0,int blue=0,int alpha=255])。_色度Objo
创建新实例。颜色参数是可选的。
- sethex(字符串hexcolor)利息
将颜色设置为与大小写无关的十六进制表示法中指定的值。十六进制必须以“”开头,后跟三个或四个十六进制字节,例如“ffffff”或“ffffffff”。如果只提供三个十六进制字节,则alpha将设置为255。因此,调用sethex(“ffffff”)会为每个颜色组件(包括alpha)指定255的值。返回ms-success或ms-failure。
- setrgb(int red,int green,int blue,int alpha=255)利息
设置所有四个rgba组件。返回ms-success或ms-failure。
- to-()一串
对sethex的补充,返回颜色组件的十六进制表示。如果alpha为255,则这是三个十六进制字节“rrggbb”,否则是四个十六进制字节“rrggbbaa”。
Error Objr¶
此类允许检查mapserver错误堆栈。只有当其他语言模块通过异常暴露错误堆栈时,Perl模块才需要。
错误对象属性¶
- 代码利息
mapserver错误代码,如ms_imgerr(1)。
- 消息一串
上下文相关错误消息。
- 常规一串
在其中设置错误的mapserver函数。
错误对象方法¶
- 下一个Error Objr
返回堆栈中的下一个错误,如果已到达结尾,则返回空值。
FutStutObjo¶
fontsetobj始终是mapobj的“fontset”属性。
fontsetobj属性¶
- 文件名字符串不可变
磁盘上fontset文件的路径。
- 字体:hashtableobj_uu不可变hashtableobj不可变
字体映射。
- 努姆庞茨不可变的
集合中的字体数。
fontsetobj方法¶
没有
哈希表对象¶
hashTableObj是一个非常简单的将不区分大小写的字符串键映射到单个字符串值的映射。地图、图层和类 metadata 一直以来都是散列哈勃,现在这些直接暴露。这是一个有限的哈希,不能包含超过41个值。
hashTableObj属性¶
- 数字项不可变的
哈希项的数目。
HashTableObj方法¶
- 清除()无效
清空所有项目的表。
- get(字符串键[,字符串默认值=空])一串
按其返回项的值 key, 或 default 如果密钥不存在。
- 下一个键([字符串键=空])一串
返回下一个键的名称,如果没有有效的下一个键,则返回空值。如果输入 key 为空,返回第一个键。
- 删除(字符串键)利息
按其移除哈希项 key. 返回ms-success或ms-failure。
- set(字符串键,字符串值)利息
设置哈希项。返回ms-success或ms-failure。
图像对象¶
图像对象是gd和gdal图像的包装器。
图像对象属性¶
- 格式:输出格式不可变输出格式obj不可变
图像格式。
- 高度不可变的
以像素为单位的图像高度。
- 意象派字符串不可变
如果图像由mapobj.draw()绘制,则这是mapobj的web.imagepath。
- 意象派字符串不可变
如果图像是由mapobj.draw()绘制的,则这是mapobj的web.imageurl。
- 渲染器利息
ms_render_with_gd,ms_render_with_swf,ms_render_with_rawdata,ms_render_with_pdf,或ms_render_with_imagemap。别搞砸了!
- 大小不可变的
要访问此属性,请使用getSize方法。
注解
GetSize方法效率低下,因为它调用GetBytes,然后计算字节数组的大小。然后立即丢弃bytearray。在大多数情况下,直接调用getbytes更有效。
- 宽度不可变的
图像宽度(像素)。
ImageObj方法¶
- 新imageobj(int width,int height[,outputformatobj_uuformat=null[,string filename=null])图像对象
创建ImageObj的新实例。如果 filename 如果指定,则从该文件创建ImageObj,并且 宽度, 高度, 和 format 参数将被中图像的值覆盖 文件名. 否则,如果 format 指定了使用该格式创建的ImageObj。见 format 属性的详细信息。如果 filename 未指定,则 width 和 height 应指定。
- GETBYTESE()二进制数据
以二进制缓冲区的形式返回图像内容。此缓冲区的确切形式将由MaScript语言(如Python中的字符串、爪哇中的字节[]数组和Cyperi中未处理的Perl)而变化。
- 获取大小()利息
重新计算表示图像缓冲区的二进制缓冲区的大小。
注解
GetSize方法效率低下,因为它调用GetBytes,然后计算字节数组的大小。然后立即丢弃字节数组。在大多数情况下,直接调用getbytes更有效。
- 保存(字符串文件名[,mapobj_u parent_map=null])利息
保存图像到 文件名. 可选的 parent_map 保存geotiff图像时必须指定参数。
- 写入([文件文件=空])利息
将图像数据写入打开的文件描述符,或者默认情况下写入 标准输出. 返回ms-success或ms-failure。
注解
此方法当前仅对python和c启用。C支持写入流对象。Perl、Ruby和Java需要用户提供的类型映射。
注解
ImageObj的free()方法已被弃用。在MapServer版本4+中,所有ImageObj实例都将由解释器的Garabage收集器正确处理。如果应用程序不能等待Garabage集合,那么可以简单地删除或取消该实例。
英塔雷¶
Intaray是Swig生成的一个实用程序类,可用于操作地图图层的绘制顺序。有关mapscript使用的讨论,请参见mapobj::getlayersdrawingorder,完整参考请参见http://www.swig.org/doc1.3/library.html library_nn5。
Intaray属性¶
没有
Intaray方法¶
- 新Intaray(int numitems)英塔雷
返回指定长度的新实例。
标签缓存成员对象¶
单个功能标签。labelcachememberobj类与labelcacheobj:关联:
+------------------+ 0..* 1 +------------+
| LabelCacheMember | <--------- | LabelCache |
+------------------+ +------------+
labelcachememberobj属性¶
- 类别索引不可变的
已标记功能的类的索引。
- 特征尺寸浮动不变
TODO
- 标签:labelobj_uuu不可变labelobj不可变
从已标记功能的类复制。
- 层次索引不可变的
标记要素的图层索引。
- 数字不可变的
标签要素类的样式数。
- 点:点不可变PointObj不可变
标签点。
- 多边形:形状对象不可变shapeobj不可变
标记边界框。
- 形态指数不可变的
标记功能的shapefile中的索引。
- 地位不可变的
标签是否已绘制?
- 样式:StyleObj_uuu不可变StyleObj不可变
TODO 这应该防止开关。
- 文本字符串不可变
标签文本。
- 倾斜指数不可变的
标记特征层的tileindex。
LabelCaseObjo¶
映射的缓存标签集。除了作为mapobj的“labelcache”属性之外,没有其他存在。与labelcachememberobj和markercachememberobj关联:
+------------+ 1 0..* +-------------------+
| LabelCache | ---------> | LabelCacheMember |
+------------+ + ----------------- +
| MarkerCacheMember |
+-------------------+
labelcacheobj属性¶
- 高速缓存不可变的
TODO
- 马克萨克化不可变的
TODO
- 数字标记不可变的
标签成员数。
- 数字标记不可变的
标记成员的数目。
labelcacheobj方法¶
- 弗雷切奇()无效
释放labelcache。
拉贝洛夫¶
labelobj与classobj、scalebarobj或legendobj关联:
+-------+ 0..1 1 +----------+
| Label | <--------- | Scalebar |
+-------+ | -------- |
| Legend |
+----------+
+-------+ 0..* 1 +-------+
| Label | <--------- | Class |
+-------+ +-------+
labelobj的实例可以存在于Classobj容器之外,并显式插入Classobj::
new_label = new labelObj()
the_class.addLabel(new_label)
labelobj属性¶
- 角浮动
TODO
- 反别名利息
MS_TRUE 或 MS_FALSE
- 自动角度利息
MS_TRUE 或 MS_FALSE
- 自动配流利息
MS_TRUE 或 MS_FALSE 。告诉MapServer计算适当线性特征的曲线标签(请参见 MS RFC 11:支持曲线标签 具体情况)。
- 自动进料尺寸:int
MS_TRUE 或 MS_FALSE
- backgroundcolor色度Objo
背景矩形或广告牌的颜色。
6.0 版后已移除: 使用styleobj_u和geomtransform。
- backgroundshadowcolor色度Objo
背景矩形或广告牌阴影的颜色。
6.0 版后已移除: 使用styleobj_u和geomtransform。
- 背景阴影尺寸利息
放置阴影的水平偏移量(像素)。
6.0 版后已移除: 使用styleobj_u和geomtransform。
- 背景阴影尺寸利息
放置阴影的垂直偏移(像素)。
6.0 版后已移除: 使用styleobj_u和geomtransform。
- 缓冲区利息
也许应该将其命名为“padding”,因为它就是这样的:标签周围以像素为单位的padding。
- color色度Objo
前景颜色。
- 编码一串
支持用于标签的编码格式。如果不支持该格式,则不会绘制标签。需要iconv库(大多数系统上都有)。如果系统上存在库,则始终会检测到该库,如果不存在,则不会绘制标签。在MapServer中显示国际字符时必需。更多信息请访问:https://mapserver.org/mapfile/encoding.html
- 字体一串
TrueType字体的名称。
- 力利息
MS_TRUE 或 MS_FALSE 。
- 最大尺寸利息
缩放标签的最大高度(像素)。请参见layerobj_uu的symbolscale属性。
- 最小距离利息
重复标签之间的最小距离(像素)。
- 最小特征尺寸利息
此尺寸较大的特征将被标记。
- 最小尺寸利息
最小高度(像素)。
- 数字利息
标签样式数
- 偏移量x利息
标签的水平偏移量。
- 杂乱利息
标签的垂直偏移。
- outlinecolor色度Objo
一点轮廓的颜色。
- 分音利息
ms_true(默认)或ms_false。标签是否可以流过地图边缘。
- 位置利息
MS_UL, MS_UC, MS_UR, MS_CL, MS_CC, MS_CR, MS_LL, MS_LC, MS_LR, or MS_AUTO.
- shadowcolor色度Objo
放置阴影的颜色。
- 阴影线利息
放置阴影的水平偏移量(像素)。
- 幽灵利息
放置阴影的垂直偏移(像素)。
- 大小利息
注释高度(像素)。
类型:在版本7.0中删除。所有标签均为TrueType。
- 包一串
将在其上断开图例文本以生成多行图例的字符。
Labelobj方法¶
- 转换字符串()一串
将对象保存到字符串。为UpdateFromString提供反转选项。
6.4 新版功能.
- getbinding(int绑定)一串
获取指定标签属性的属性绑定。如果此属性没有绑定,则返回空值。
- GetExpressionString()。一串
返回标签表达式字符串。
- GetStyle(int索引)_样式对象
返回对StyleObj的引用 index 在样式数组中。
- 获取文本字符串()一串
返回标签文本字符串。
- insertStyle(styleobj_u style[,int index=-1])利息
插入一个 copy 属于 style 到索引处的样式数组中 指数. 默认值为-1,或数组的结尾。返回插入样式的索引。
- moveStyleDown(int索引)利息
交换StyleObj index 带样式obj index + 1。
- moveStyleup(int索引)利息
交换StyleObj index 带样式obj index - 1。
- removebinding(int绑定)利息
移除specField标签属性的属性绑定。
- 删除样式(int index)_样式对象
删除处的StyleObj index 从样式数组中返回一个副本。
- setbinding(int绑定,字符串项)利息
设置指定标签属性的属性绑定。绑定常量如下所示:ms_label_binding_uuu[属性名]:
setBinding(MS_LABEL_BINDING_COLOR, "FIELD_NAME_COLOR");
- setExpression(字符串表达式)利息
设置标签表达式。
- settext(字符串文本)利息
设置标签文本。
- updatefromstring(字符串片段)利息
从字符串片段更新标签。返回ms-success/ms-failure。
层对象¶
layerobj与mapobj关联。在最新版本中,layerObj的实例可以存在于mapobj之外:
+-------+ 0..* 0..1 +-----+
| Layer | <--------> | Map |
+-------+ +-----+
layerobj的另一个重要关联是与classobj_u::
+-------+ 1 0..* +-------+
| Layer | <--------> | Class |
+-------+ +-------+
和hashtableobj_uu::
+-------+ 1 1 +-----------+
| Layer | ---------> | HashTable |
+-------+ | -- |
| metadata |
+-----------+
layerobj属性¶
- 班斯廷一串
索引文件中用于选择要使用的源栅格带的属性。对于默认带区处理,通常为空。
- 类项目一串
用于对层数据进行分类的属性。
- 连接一串
层连接或DSN。
- 连接类型利息
有关可能的值,请参见mapserver.h中的ms_connection_type。设置连接类型时,应使用setConnectionType()以正确初始化层vTable。
- 数据一串
层数据定义,值取决于连接类型。
- 调试利息
启用层调试。ms-on或ms-off(默认)。
- 倾倒利息
从6.0开始,“dump”不再可用。而是使用元数据。
切换到允许MapServer以GML格式返回数据。 MS_TRUE 或 MS_FALSE。默认值为 MS_FALSE 。
6.0 版后已移除: 而是使用元数据。
- extent雷克托布杰
层特征的可选限制范围。
- 过滤项一串
属性定义筛选器。
- 页脚一串
TODO
- 组一串
一组层的名称。
- 页眉一串
TODO
- 指数不可变的
父映射层数组中的层索引。
- 标签项目一串
属性定义标签角度。
- 标记缓存利息
MS_ON 还是 MS_OFF。默认值为 MS_ON。
- 标签项目一串
定义特征标签文本的属性。
- 标签最大刻度浮动
标记图层的最小比例。
- labelminscaledenom公司浮动
标记图层的最大比例。
- 标签要求一串
逻辑表达式。
- 标记项一串
定义标签大小的属性。
- 地图:地图不可变MABOBJ不可变
对父映射的引用。
- 面具一串
遮罩的层名称。( MS RFC 79:层屏蔽 )
- 最大特征量利息
将绘制的图层要素的最大数目。对于shapefile数据,这意味着前n个特征,其中n=maxfeatures。
- 最大刻度浮动
绘制图层的最小比例。
- 元数据:hashtableobj_uu不可变hashtableobj不可变
层元数据。
- 最小尺度浮动
绘制图层的最大比例。
- 名称一串
层的唯一标识符。
- 数字类不可变的
层类的数目。
- 数字项不可变的
层特征属性(项)的数目。
- 数字连接不可变的
层连接数。
- 数字处理不可变的
栅格处理指令的数目。
- offsite色度Objo
栅格层的透明像素值。
- 不透明性利息
层不透明度百分比范围[0,100]。ms_gd_alpha(1000)的特殊值表示应遵守pixmap符号的alpha透明度,并且应仅用于使用rgba pixmap符号的层。
注解
不推荐使用不透明度(从MapServer 7.0开始),而应通过层的 COMPOSITE 块(另请参见下面的layerObj的setOpacity()&getOpacity()方法)。
- 标签缓存利息
MS_TRUE 或 MS_FALSE 。默认值为 MS_FALSE 。
- 要求一串
逻辑表达式。
- 尺寸单位利息
类大小值的单位。ms-in、ms-feet、ms-miles、ms-nauticalmiles、ms-meters、ms-km、ms-dd或ms-u像素
- 地位利息
ms-on、ms-off或ms-default。
- 样式项一串
属性定义样式。
- 符号尺度浮动
符号默认大小的比例。
- 模板一串
模板文件。请注意,出于历史原因,查询属性必须为非空才能查询层。
- 倾斜指数一串
用于平铺支持的层索引文件。
- 梯级项目一串
定义平铺路径的属性。
- 容忍浮动
搜索点查询和行查询的缓冲区。
- 公差单位利息
ms-in、ms-feet、ms-miles、ms-nauticalmiles、ms-meters、ms-km、ms-dd或ms-u像素
- 转型利息
是否将图层数据转换为图像单位。_true或_false女士。默认值为ms_true。对于图像坐标(如注释点)中的数据,ms_false是一种情况。
- 类型利息
请参见mapserver.h中的ms_layer_type。
- 单位利息
层的单位。请参阅mapserver.h中的ms_units。
层对象方法¶
- 新建layerObj([MABOBJ_uu parent_map=null])层对象
在中创建新层obj parent_map. 新layerObj的层索引将等于 parent_map 数字层-1.这个 parent_map arg现在是可选的,层可以存在于地图之外。
- 添加功能(shapeobj_uushape)利息
在图层上添加新的内嵌特征。出错时返回-1。 TODO: 这是否与mapfile中的内联功能类似?它是否适用于任何类型的层或连接类型?
- addprocessing(字符串指令)无效
向层添加新的处理指令行,类似于 Mapfile 中的处理指令。支持的处理指令特定于层类型和底层渲染器。
- applysld(字符串sld,字符串样式层)利息
将SLD文档应用于层对象。SLD文档和层之间的匹配将使用层的名称完成。如果传递了namedlayer参数(参数是可选的),则SLD中匹配该参数的namedlayer将用于设置层的样式。有关SLD支持的更多信息,请参阅SLD howto。
- applysldurl(字符串sld,字符串样式层)利息
将URL指向的SLD文档应用于层对象。SLD文档和层之间的匹配将使用层的名称完成。如果传递了namedlayer参数(参数是可选的),则SLD中匹配该参数的namedlayer将用于设置层的样式。有关SLD支持的更多信息,请参阅SLD howto。
- 清除处理()利息
清除图层的栅格处理指令。返回后续的指令数,如果清除了这些指令,则等于ms_success。
- 克隆()层对象
返回没有父映射的层的独立副本。
- 关闭()无效
关闭底层。
- 转换字符串()一串
将对象保存到字符串。为UpdateFromString提供反转选项。
6.4 新版功能.
注解
在MapServer 4.4中删除了demote()。
- 绘制(MABOBJ UUU MAP,IMAGEOBJ UUU IMAGE)利息
将此层呈现到目标图像中,并在需要时向缓存添加标签。返回ms-success或ms-failure。 TODO: 地图是否需要定义图层的地图?我怀疑是这样。
- DrawQuery(地图、图像、图像):
在目标图像中绘制单层的查询映射。返回ms-success或ms-failure。
- 执行wfsgetfeature(层)一串
在WFS层上执行GetFeature请求,并返回创建的临时GML文件的名称。出错时返回空字符串。
- 派生程序()无效
基于层中找到的所有类返回SLD XML字符串(该层必须具有“status`` on`”)。
- getClass(内部I)_类对象
获取请求的类对象。如果类索引超出合法范围,则返回空值。numClasses字段包含可用的类数,第一个类是索引0。
- GETExtEnter()雷克托布杰
获取层中数据的范围。这通常需要对图层的特性进行完全读取,但不适用于栅格图层。
- GetFeature(int shapeindex[,int tileindex=-1])。_形状对象
返回层功能 shapeindex 和 倾斜指数.
注解
GetFeature已从6.0版中删除,并替换为GetShape
- 获取筛选字符串()一串
返回当前筛选器表达式。
- 获取第一个元数据键()一串
返回元数据哈希表中的第一个键。使用getNextMetadataKey(),在键上提供不透明的迭代器。
注解
getFirstMetadataKey()、getMetadata()和getNextMetadataKey()已弃用,将在未来版本中删除。替换为直接元数据访问,请参见hashtableobj_uuu。
- 获取项(int i)一串
返回请求的项。项是属性字段,此方法返回项名称(字段名称)。numitems字段包含可用的项目数,第一个项目是索引零。
- GetMetadata(字符串键)一串
返回值 key 来自元数据哈希表。
注解
getFirstMetadataKey()、getMetadata()和getNextMetadataKey()已弃用,将在未来版本中删除。替换为直接元数据访问,请参见hashtableobj_uuu。
- GetNextMetadataKey(字符串LastKey)一串
返回元数据哈希表中的下一个键,如果 lastkey 是最后一个有效密钥。如果 lastkey 为空,返回元数据哈希表的第一个键。
注解
getFirstMetadataKey()、getMetadata()和getNextMetadataKey()已弃用,将在未来版本中删除。替换为直接元数据访问,请参见hashtableobj_uuu。
- GetNumFeatures()。利息
返回层中的内联功能数。 TODO: 这真的只是在线功能,还是返回常规层上非在线功能的数量?
- GETNUMultRESUTSH()利息
返回此层的查询结果缓存中的条目数。
- 获取不透明度()利息
返回层的不透明度值。
- GetProcessing(int索引)一串
返回栅格处理指令 指数.
- 获取投影()一串
返回层投影的项目定义。
- 获取结果(int i)_结果缓存成员对象
获取请求的查询结果缓存项,如果索引超出可用结果的范围,则为空。此方法通常只在发出查询操作后使用。
- GETRESULTS()结果对象
返回对层结果缓存的引用。在任何查询之前、失败的查询或没有结果的查询之后都应为空。
- GetResultsBounds()。_雷克托布杰
返回结果缓存中功能的边界。
- getshape(resultCacheMemberObj_uuResult)利息
从层数据中获取形状。参数是layerObj::GetResult(i)的结果缓存成员
- getwmsfeatureinfourl(mapobj_u map,int click_x,int click_y,int feature_count,string info_format)一串
返回一个wms getfeatureinfo url(仅适用于wms层)clickx,clicky是要在像素坐标中查询的位置,其中(0,0)位于图像的左上角。FeatureCount是要返回的结果数。infoformat是请求结果的格式。取决于远程服务器的功能。mapserver wms服务器只支持“mime”(很快就会支持“gml.1”)。如果层不是WMS层或不可查询,则返回“”并输出警告。
- insertclass(classobj_u class[,int index=-1])利息
插入一个 copy 将类放入请求的层 指数. 默认索引-1表示在类数组的末尾插入。返回插入类的索引。
- 可看见的()利息
在父映射上下文中考虑层状态、minscaledenom和maxscaledenom后,返回ms-true或ms-false。
- 向下移动类(int类)利息
类索引指定的类将向上移动到层数组中。返回ms-success或ms-failure。例如,moveClassDown(1)将具有将类别1向下移动到位置2的效果,并且位置2的类别将移动到位置1。
- moveClassup(int类)利息
类索引指定的类将向上移动到层数组中。返回ms-success或ms-failure。例如,moveClassup(1)将具有将类别1向上移动到位置0的效果,并且位置0的类别将移动到位置1。
- nEXFILL()形状对象
在调用mswhichshapes以实际检索给定区域内的形状后调用,返回shape对象或ms_false
用法示例:
mapObj map = new mapObj("d:/msapps/gmap-ms40/htdocs/gmap75.map"); layerObj layer = map.getLayerByName('road'); int status = layer.open(); status = layer.whichShapes(map.extent); shapeObj shape; while ((shape = layer.nextShape()) != null) { ... } layer.close();
- 打开()无效
打开基础层。这在getFeature()之类的操作工作之前是必需的,但在draw或query调用之前不是必需的。
注解
在MapServer 4.4中取消了promote()。
- querybyattributes(mapobj_u map,string qitem,string qstring,int模式)利息
查询与当前地图范围相交的形状的图层。qitem是执行查询的项(属性),qstring是要匹配的表达式。查询将在属于包含模板值的类或与包含层模板值的层中的任何类匹配的所有形状上执行。
请注意,此函数将忽略层的筛选器/筛选器项。根据您想要的结果数量,模式是ms-single或ms-multiple。如果找到形状,则返回ms-success;如果未找到任何形状,则返回ms-failure;如果发生其他错误,则返回ms-failure。
- QueryByFeatures(mapobj_u映射,int slayer)利息
根据另一层的前一组结果执行查询集。目前,结果必须基于多边形层。如果找到形状,则返回ms-success;如果未找到任何形状,则返回ms-failure;如果发生其他错误,则返回ms-failure
- querybyindex(mapobj_u map,int shapeindex,int tileindex[,int baddtoquery=ms_false])利息
将查询结果成员弹出到层的结果缓存中。默认情况下会破坏现有缓存。返回ms-success或ms-failure。
- querybypoint(mapobj_u映射、pointobj_u点、int模式、浮点缓冲区)利息
在地理参考地图坐标中指定的点位置查询图层(即,不是像素)。查询将在属于包含模板值的类或与包含层模板值的层中的任何类匹配的所有形状上执行。根据您想要的结果数量,模式是ms-single或ms-multiple。传递缓冲区<=0默认为 Mapfile 中设置的公差(以像素为单位),但可以使用常量缓冲区(以地面单位指定)。如果找到形状,则返回ms-success;如果未找到任何形状,则返回ms-failure;如果发生其他错误,则返回ms-failure。
- querybyrect(映射,矩形)利息
使用地理参考地图坐标中指定的矩形(即非像素)查询图层。查询将在属于包含模板值的类或与包含层模板值的层中的任何类匹配的所有形状上执行。如果找到形状,则返回ms-success;如果未找到任何形状,则返回ms-failure;如果发生其他错误,则返回ms-failure。
- 按形状查询(mapobj_u map,shapeobj_u shape)利息
查询层基于单个形状,此时形状必须是多边形。如果找到形状,则返回ms-success;如果未找到任何形状,则返回ms-failure;如果发生其他错误,则返回ms-failure
- removeClass(int索引)_类对象
删除指示的类并返回副本,如果失败则返回空值。请注意,此操作将对后续类重新编号。numClasses字段包含可用的类数。
- removemetadata(字符串键)利息
删除处的元数据哈希 key. 返回ms-success或ms-failure。
注解
removeMetadata()已弃用,将在未来版本中删除。替换为直接元数据访问,请参见hashtableobj_uuu。
- 结果setshape(int shapeindex[,int tileindex=-1])形状对象
按索引从层的结果集检索shapeobj。tileindex是可选的,仅用于平铺的形状文件,对于其他数据源,只需省略或传递tileindex=-1即可。由于一次通过查询实现,在MapServer 5.6.0中添加了。
- setconnectiontype(int connectiontype,字符串库u str)利息
更改层的连接类型,并根据新的连接类型重新创建vtable。应该使用此方法而不是直接设置ConnectionType参数。如果layer.connectiontype=ms_plugin,还应指定library_str参数,以便选择要由mapserver加载的库。对于其他连接类型,不使用此参数。
- 设置范围(float minx、float miny、float maxx、float maxy)利息
设置层的范围。返回ms-success或ms-failure。
- setfilter(字符串筛选器)利息
设置与 Mapfile 中的筛选器表达式类似的筛选器表达式。如果表达式解析失败,则返回ms-success on success或ms-failure。
- setmetadata(字符串键、字符串值)利息
赋值 value 到处的元数据哈希 key. 返回ms-success或ms-failure。
注解
setmetadata()已弃用,将在将来的版本中删除。替换为直接元数据访问,请参见hashtableobj_uuu。
- 设置不透明度(字符串不透明度)利息
设置层的不透明度,其中值是范围内的整数 [0, 100] . 一个新的 COMPOSITE 将生成包含此不透明度值的块。
- setprocessingkey(字符串键、字符串值)无效
添加或替换“key=value”形式的处理指令。与addprocessing()调用不同,这将替换给定键值的现有处理指令。支持的处理指令特定于层类型和底层渲染器。
- setprojection(字符串proj4)利息
使用PROJ格式投影定义(即“+PROJ=utm+zone=11+datum=WGS84”或“init=EPSG:26911”)设置图层投影。返回MS_SUCCESS或MS_FAILURE。
- setwktprojection(字符串wkt)利息
使用OpenGIS众所周知的文本格式设置图层投影。返回ms-success或ms-failure。
- 形状(矩形)利息
执行空间和基于属性的特征搜索(可选)。该函数基本上准备好了一些东西,以便查询或绘图函数(例如使用nextshape函数)可以访问候选特性。返回ms-success、ms-failure或ms-done。如果层范围不重叠rect,则返回ms-done。
传奇对象¶
legendobj与mapobj关联::
+--------+ 0..1 1 +-----+
| Legend | <--------> | Map |
+--------+ +-----+
还有拉贝罗布:
+--------+ 1 1 +-------+
| Legend | ---------> | Label |
+--------+ +-------+
legendobj属性¶
- 高度利息
传说高度。
- imagecolor色度Objo
图例背景色。
- 凯西泽利息
图例键的宽度(以像素为单位)。
- 基西齐利息
像素。
- 密钥空间利息
关键点周围的水平填充(像素)。
- 键间距利息
垂直填充。
- 标签:labelobj_uuu不可变labelobj不可变
传奇标签。
- 地图:地图不可变MABOBJ不可变
对父mapobj的引用。
- outlinecolor色度Objo
关键轮廓颜色。
- 位置利息
MS_UL, MS_UC, MS_UR, MS_LL, MS_LC, or MS_LR.
- 标签缓存利息
MS_TRUE 或 MS_FALSE 。
- 地位利息
MS_ON, MS_OFF, or MS_EMBED.
- 模板一串
模板文件的路径。
- 宽度利息
标签宽度。
legendobj方法¶
- 转换字符串()一串
将对象保存到字符串。为UpdateFromString提供反转选项。
6.4 新版功能.
线路对象¶
LineObj由一个或多个PointObj实例组成:
+------+ 0..1 1..* +-------+
| Line | ---------> | Point |
+------+ +-------+
LineObj属性¶
- 点数不可变的
行中的点数。
线性Objo方法¶
- 新线性对象()线路对象
创建新实例。
- 添加(点对象点)利息
添加 point 排队。返回ms-success或ms-failure。
- 获取(int索引)彭波托基
返回点的引用 指数.
- 项目(ProjectionObj项目输入,ProjectionObj项目输出)利息
将线条从 proj_in 到 proj_out. 返回ms-success或ms-failure。
- 集合(int index,pointobj_uu point)利息
设定点为 index 到 点. 返回ms-success或ms-failure。
MAPbOBJ¶
mapobj主要与layerobj的实例相关联:
+-----+ 0..1 0..* +-------+
| Map | <--------> | Layer |
+-----+ +-------+
次要关联包括legendobj、scalebarobj、referencemapobj::
+-----+ 1 0..1 +--------------+
| Map | ---------> | Legend |
+-----+ | ------------ |
| Scalebar |
| ------------ |
| ReferenceMap |
+--------------+
输出格式对象:
+-----+ 1 1..* +--------------+
| Map | ---------> | OutputFormat |
+-----+ +------------- +
MAPOBJ属性¶
- 栅格尺寸浮动
以地图单位表示的像素大小。
- 配置选项hashobj不可变
.map中config关键字的配置选项哈希表。不鼓励直接访问配置选项。请改用setconfigOption()和getconfigOption()方法。
- 数据表一串
TODO 不确定这对mapscript是否有意义。
- 调试利息
MS_TRUE 或 MS_FALSE 。
- extent雷克托布杰
地图的空间范围。
- fontset:fontsetobj_uu不可变fontsetobj不可变
地图定义的字体。
- 高度利息
地图的输出图像高度(像素)。
注解
直接设置 height 在MapServer 4.4版中已弃用。用户应该使用setSize()同时设置宽度和高度。
- imagecolor色度Objo
初始地图背景色。
- 图像质量利息
JPEG图像质量。
注解
map imagequality在mapserver 4.4中已被弃用,应改为通过map outputformats进行管理。
- 图像类型字符串不可变
当前输出格式的名称。
- 交织利息
输出图像交错。
注解
map interlace在mapserver 4.4中已被弃用,应改为通过map outputformats进行管理。
- labelcacheobj不可变labelcacheobj不可变
地图的labelcache。
- 图例:legendobj_uuu不可变legendobj不可变
对地图图例的引用。
- 映射器一串
映射映射 Mapfile 的文件系统路径。
- 最大尺寸利息
TODO 是吗?
- 名称一串
唯一标识符。
- 数字符号不可变的
地图图层数。
- 数字输出格式利息
映射对象上当前配置的输出格式数。可以使用getoutputformat(idx)方法(见下文)迭代输出格式列表。
- outputformat输出格式对象
当前选定的输出格式。
注解
不应直接修改映射输出格式。使用selectoutputformat()方法选择命名格式。
- 输出格式列表输出格式obj[]
可用输出格式的数组。
注解
目前仅适用于C。应为其他语言实现适当的类型映射。
注解
从6.2开始,其他语言可以使用getOutputformat(idx)和getNumOutputformas()函数在格式数组上迭代。
- 查询程序querymapobj不可变
TODO 这应该向mapscript公开吗?
- 引用:referencemapobj_uu不可变referencemapobj不可变
参考地图。
- 分辨率浮动
名义dpi分辨率。默认值为72。
- 比例尺:比例尺不可变不可变的可缩放机器人
参照比例尺。
- 缩放索引浮动
名义地图比例尺。25000表示1:25000比例。
- 肖佩思一串
基本文件系统到层数据的路径。
- 地位利息
ms-off、ms-on或ms-default。
- 符号集:符号不可变符号不可变
地图上的一组符号。
- 模板模板一串
TODO 不确定这对mapscript是否有意义。
- 透明的利息
MS_TRUE 或 MS_FALSE 。
注解
map transparent在mapserver 4.4中已被弃用,应改为通过map outputformats进行管理。
- 单位利息
MS_DD, MS_METERS, 等.
- web:webobj不可变webobj不可变
对映射的Web定义的引用。
- 宽度利息
地图的输出图像宽度(像素)。
注解
直接设置 width 在MapServer 4.4版中已弃用。用户应该使用setSize()同时设置宽度和高度。
MAPOBJ方法¶
- 新建MAPOBJ([字符串文件名='])MAPbOBJ
创建MAPOBJ的新实例。请注意,文件名现在是可选的。
- appendoutputformat(outputformatobj_u格式)利息
附加 format 到地图的输出格式列表。返回更新的输出格式数。
- 应用程序配置()。无效
应用由setconfigOption()设置的已定义配置选项。
- applysld(字符串sldxml)利息
分析SLD XML字符串 sldxml 并应用于地图图层。返回ms-success或ms-failure。
- applysldurl(字符串sldurl)利息
从URL获取SLD XML sldurl 并应用于地图图层。返回ms-success或ms-failure。
- 克隆()MAPbOBJ
返回映射的独立副本,减去任何缓存。
注解
在Java模块中,这个方法被命名为“C克隆MaP”。
- 转换字符串()一串
将对象保存到字符串。
注解
对于mapobj,反向方法updatefromstring不存在
6.4 新版功能.
- 拉伸()图像对象
绘制地图,根据定义的顺序和状态处理图层。返回ImageObj。
- DrawLabelCache(图像对象图像)利息
在上绘制地图的标签缓存 形象. 返回ms-success或ms-failure。
- 牵引传奇()图像对象
绘制地图图例,返回ImageObj。
- 拖尾查询()图像对象
绘制查询映射,返回ImageObj。
- 图纸参考图()。_图像对象
绘制参考图,返回ImageObj。
- DrawscaleBar()。_图像对象
绘制比例尺,返回ImageObj。
- 嵌入图例(imageobj_uu image)利息
将地图的图例嵌入 形象. 返回ms-success或ms-failure。
- Embedscalebar(图像对象图像)利息
将地图的比例尺嵌入 形象. 返回ms-success或ms-failure。
- 自由查询([int qlayer=-1])无效
清除层查询结果缓存。默认值为-1,或 all 层。
- 母体()一串
将sld xml作为具有'status``on`的映射层的字符串返回。
- getconfig选项(字符串键)一串
如果设置,则获取请求的配置密钥的值。如果未设置键,则返回空值。
- 获取第一个元数据键()一串
返回web.metadata哈希表中的第一个键。使用getNextMetadataKey(),可以在键上提供不透明的迭代器。
- 获取标签(int labelindex)_标签缓存成员对象
从映射的labelcache返回指定索引处的标签。
- GetLayer(int索引)_层对象
返回对位于的层的引用 指数.
- getlayerByName(字符串名称)_层对象
返回对命名层的引用。
- GetlayersDrawingOrder()。INT*
按绘图顺序返回层索引数组。
注解
除非为模块的语言实现了正确的类型映射,否则用户更有可能返回到整数数组的不可用swig指针。
- GetMetadata(字符串键)一串
返回值 key 来自web.metadata哈希表。
- GetNextMetadataKey(字符串LastKey)一串
返回web.metadata哈希表中的下一个键,如果 lastkey 是最后一个有效密钥。如果 lastkey 为空,返回元数据哈希表的第一个键。
- 获取数字符号()利息
返回地图中的符号数。
- getoutputformat(int i):输出格式obj
返回指定位置的输出格式 i 输出格式数组中的索引,如果 i 超出数组边界。可以通过调用 获取数字输出格式.
- GetOutputFormatByName(字符串ImageType)_输出格式对象
返回驱动程序名称对应的输出格式 imagetype 或格式化名称 图像类型. 这与mapfile中的imagetype指令完全相同,不区分大小写,允许通过驱动程序(如“gd/png”)或名称(如“png24”)找到输出格式。
- 获取投影()一串
返回映射投影的项目定义。
- getsymbolbyname(字符串名称)利息
返回地图符号集中命名符号的索引。
注解
这个方法的名称不好,而且太间接。最好使用symbolsetobj的getsymbolbyname方法,这确实会返回symbolobj引用,或者使用symbolsetobj的index方法来获取符号的索引号。
- 插入层(layerObj layer[,int nindex=-1])利息
插入的副本 layer 进入索引处的地图 N索引. 默认值为 nIndex 是-1,这意味着最后一个可能的索引。返回新层的索引,如果失败则返回-1。
- loadmapcontext(字符串文件名[,int useuniquenames=ms_false])利息
加载OGC映射上下文文件以定义映射的范围和层。
- loadowsparameters(owsrequest_uurequest[,string version='1.1.1'])利息
将OWS请求参数(bbox、layers和c)加载到地图中。返回ms-success或ms-failure。
- loadquery(字符串文件名)利息
加载保存的查询。返回ms-success或ms-failure。
- movelayerdown(int层索引)利息
将层移动到 layerindex 在绘图顺序数组中,这意味着它将在后面绘制。返回ms-success或ms-failure。
- movelayerup(int层索引)利息
将层移动到 layerindex 在绘图顺序数组中向上,这意味着它是较早绘制的。返回ms-success或ms-failure。
- NEXPLACK()标签缓存成员对象
从地图的labelcache返回下一个标签,允许对标签进行迭代。
注解
NextLabel()已弃用,将在将来的版本中删除。替换为GetLabel()。
- OWS显示(OWS请求请求请求)利息
处理并执行地图上传递的OpenGIS Web服务请求。如果req对象中没有有效的OWS请求,则返回ms_done(2),如果成功处理了OWS请求,则返回ms_success(0),如果未成功处理OWS请求,则返回ms_failure(1)。OWS请求包括MAPServer支持的WMS、WFS、WCS和SOS请求。已调度请求的结果将写入stdout,并可以使用msio服务(即msio_installstdouttobuffer()和msio_getstdoutbufferstring())捕获。
- 准备图像()。_图像对象
返回初始化为映射区和输出格式的ImageObj。
- 准备查询()无效
TODO 这个函数只计算比例,还是我遗漏了什么?
- processLegendTemplate(字符串名称[]、字符串值[]、int numitems)一串
处理MapServer图例模板并返回HTML。
注解
除非在目标语言的模块中实现了正确的类型映射,否则这三种模板处理方法都不可用。目前尚未实现类型映射。
- processQueryTemplate(字符串名称[]、字符串值[]、int numitems)一串
处理MapServer查询模板并返回HTML。
注解
除非在目标语言的模块中实现了正确的类型映射,否则这三种模板处理方法都不可用。目前尚未实现类型映射。
- processtemplate(int generateimages,string name[],string values[],int numitems)一串
处理MapServer模板并返回HTML。
注解
除非在目标语言的模块中实现了正确的类型映射,否则这三种模板处理方法都不可用。目前尚未实现类型映射。
- QueryByFeatures(int layerIndex)利息
查询地图图层,结果集包含与之相交的要素,或包含在MS层多边形类型图层的结果集中的要素中,位于 层次索引. 返回ms-success或ms-failure。
- QueryByPoint(点对象点、int模式、浮点缓冲区)利息
查询地图层,结果集包含一个或多个功能,具体取决于 mode, 相交 point 在公差范围内 缓冲区. 返回ms-success或ms-failure。
- 查询byrect(rectobj_uurect)利息
查询地图图层,结果集包含相交或包含在 rect. 返回ms-success或ms-failure。
- 按形状查询(shapeobj_uushape)利息
查询地图图层,结果集包含相交或包含在 形状. 返回ms-success或ms-failure。
- removelayer(int索引)利息
移除层 指数.
- removemetadata(字符串键)利息
删除位于的web.metadata哈希 key. 返回ms-success或ms-failure。
- removeoutputformat(字符串名称)利息
删除名为的格式 name 从地图的输出格式列表中。返回ms-success或ms-failure。
- 保存(字符串文件名)利息
将映射保存到磁盘作为新的 Mapfile 。返回ms-success或ms-failure。
- savemapcontext(字符串文件名)利息
将映射定义保存到磁盘,作为符合OGC的XML。返回ms-success或ms-failure。
- savequery(字符串文件名)利息
将查询保存到磁盘。返回ms-success或ms-failure。
- savequeryasgml(字符串文件名)利息
将查询保存到磁盘。返回ms-success或ms-failure。
- selectoutputformat(字符串imagetype)无效
将映射的活动输出格式设置为名为 图像类型. 内置格式有“png”、“png24”、“jpeg”、“gif”、“gtiff”。
- setconfigOption(字符串键、字符串值)无效
将指示键配置选项设置为指示值。相当于在 Mapfile 中包含config关键字。
- 设置范围(float minx、float miny、float maxx、float maxy)利息
设置映射范围,返回ms-success或ms-failure。此方法将在设置minx、miny、maxx、maxy值之前更正范围(宽度/高度比)。请参见范围属性以从rectobj_uuu设置自定义范围。
- offsetextent(浮点x,浮点y)利息
根据地图坐标中给定的距离偏移地图范围,返回ms-success或ms-failure。
- scaleExtent(浮动缩放因子、浮动最小缩放比例、浮动最大缩放比例)利息
使用缩放因子缩放地图范围,并确保范围在minscaledenom和maxscaledenom域内。如果minscaledenom和/或maxscaledenom为0,则不考虑该参数。返回ms-success或ms-failure。
- 设置中心(点对象中心)利息
将地图中心设置到给定的地图点,返回ms-success或ms-failure。
- setfontset(字符串文件名)利息
加载中定义的字体 filename 映射字体集。已清除现有字体集。返回ms-success或ms-failure。
- setImageType(字符串名称)无效
将map outputformat设置为命名格式。
注解
setImageType()仍保留在模块中,但不推荐使用它,取而代之的是selectOutputFormat()。
- setlayersDrawingOrder(int layerIndexes[])利息
设置地图图层绘制顺序。
注解
除非为模块的语言实现了正确的类型映射,否则用户将无法向该方法传递数组或列表,并且该方法将不可用。
- setmetadata(字符串键、字符串值)利息
赋值 value 到web.metadata哈希 key. 返回ms-success或ms-failure。
- setoutputformat(outputformatobj_uu格式)无效
设置映射输出格式。
- setprojection(字符串proj4)利息
从项目定义字符串设置映射投影 项目4 .
- 设置旋转(浮动旋转角度)利息
设置地图旋转角度。地图视图矩形(按范围指定)将按指示的角度逆时针旋转。请注意,这意味着渲染的地图将按顺时针方向的角度旋转。返回ms-success或ms-failure。
- 设置大小(int宽度,int高度)利息
将地图的图像宽度和高度设置在一起,并进行必要的后续地理变换计算。返回ms-success或ms-failure。
- setsymbolset(字符串文件名)利息
加载中定义的符号 filename 进入地图符号集。已清除现有符号集。返回ms-success或ms-failure。
- setwktprojection(字符串wkt)利息
根据OGC定义设置地图投影 wkt.
- 缩放点(int zoomfactor、pointobj_uugpoint、int width、int height、rectobj_uuextent、rectobj_uumaxextent)利息
缩放 zoomfactor 到 imgpoint 图像中的像素单位 height 和 width 尺寸和地理参考 程度. 缩放可以限制为最大 最大限度. 返回ms-success或ms-failure。
- 缩放矩形(矩形,宽度,高度,范围,
rectobj_uumaxextent):int缩放到图像中的像素坐标矩形 width 和 height 尺寸和地理参考 程度. 缩放可以限制为最大 最大限度. 这个 imgrect 矩形包含以像素表示的ll和ur坐标的坐标:rect对象中的maxy应小于miny值。返回ms-success或ms-failure::
------- UR (values in the rect object : maxx, maxy) | | | | | | ------ LL (values in the rectobject minx, miny)
- 缩放比例(浮动比例、点对象、点宽度、点宽度、点高度、点对象范围、点对象最大范围)利息
与前面的方法类似,但按指定比例缩放到该点。
markercachememberobj公司¶
单个标记。MarkerCacheMemberObj类与LabelCacheObj:关联:
+------------------+ 0..* 1 +------------+
| MarkerCacheMember | <--------- | LabelCache |
+------------------+ +------------+
markercachememberobj属性¶
- 身份证件不可变的
标记的ID。
- 多边形:形状对象不可变shapeobj不可变
标记边界框。
markercachememberobj方法¶
没有。
输出格式对象¶
输出格式obj与mapobj关联::
+--------------+ 1..* 1 +-----+
| OutputFormat | <--------- | Map |
+--------------+ +-----+
也可以是imageobj_uuu的属性。
输出格式对象属性¶
- 乐队利息
栅格中的带区数。仅用于“原始”模式、ms_imagemode_byte、ms_imagemode_int16和ms_imagemode_float32。通常通过“波段计数格式”选项设置…此字段应视为只读。
- 驱动一串
字符串,如“gd/png”或“gdal/gtiff”。
- 延伸一串
格式化文件扩展名,如“png”。
- 图像模利息
ms_imagemode_pc256、ms_imagemode_rgb、ms_imagemode_rgba、ms_imagemode_int16、ms_imagemode_float32、ms_imagemode_byte或ms_imagemode_null。
- 拟态一串
设置mimetype格式,如“image/png”。
- 名称一串
唯一标识符。
- numFormatOptions:整数
在此格式上设置的选项值数。可用于与*getoptionat一起迭代选项数组*
- 渲染器利息
ms_render_with_gd,ms_render_with_swf,ms_render_with_rawdata,ms_render_with_pdf,或ms_render_with_imagemap。通常根据驱动程序和构造函数中的其他设置在内部设置。
- 透明的利息
MS_ON 或 MS_OFF 。
输出格式对象方法¶
- 新建outputformatobj(字符串驱动程序[,字符串名称=驱动程序])_输出格式对象
创建新实例。如果 name 未提供,值为 driver 用作名称。
- GetOption(字符串键[,字符串默认值=“”])一串
返回格式选项 key 或 defaultvalue 如果 key 不是有效的哈希索引。
- getoptionat(int idx):字符串
如果索引超出数组边界,则返回IDX或NULL处的选项。该选项作为原始的key=value字符串返回。可以通过调用 获取数字格式选项.
- setextension(字符串扩展)无效
为输出格式(如“png”或“jpg”)设置文件扩展名。方法可能已弃用,因为扩展属性是可变的。
- setmimetype(字符串mimetype)无效
为输出格式(如“image/png”或“image/jpeg”)设置mimetype。方法可能已弃用,因为mimetype属性是可变的。
- setoption(字符串键、字符串值)无效
将格式选项设置为 key 到 价值. 格式选项主要是驱动程序特定的。
- 有效()利息
检查一些内部一致性问题,如果一切正常,则返回ms_true;如果有问题,则返回ms_false。有些问题是内部解决的。如果遇到问题,可能会生成调试输出。
OWSRequest¶
不与其他mapscript类关联。充当应用程序和MapServer的OWS功能之间的消息中介。使用它可以创建轻量级的WMS服务:
wms_map = mapscript.mapObj('wms.map')
wms_request = mapscript.OWSRequest()
# Convert application request parameters (req.args)
for param, value in req.args.items():
wms_request.setParam(param, value)
# Map loads parameters from OWSRequest, adjusting its SRS, extents,
# active layers accordingly
wms_map.loadWMSRequest('1.1.0', wms_request)
# Render the Map
img = wms_map.draw()
OWS请求属性¶
- NumParams不可变的
请求参数的数目。最终应该像其他属性一样更改为numparams小写。
- 后请求一串
TODO
- 类型利息
ms-get-u请求或ms-post-u请求。
OWS请求方法¶
- 新的OWSRequest()。OWSRequest
创建新实例。
注解
mapserver的owsrequest只支持单值参数。
- addParameter(字符串名称、字符串值)无效
添加一个请求参数,即使参数键是预先设置的。当需要具有相同键的多个参数时,这很有用。例如::
request.addParameter('SIZE', 'x(100)') request.addParameter('SIZE', 'y(100)')
- getname(int索引)一串
返回位于的参数的名称 index 在请求的参数名数组中。
- GetValue(int索引)一串
返回参数的值 index 在请求的参数值数组中。
- GetValueByName(字符串名称)一串
返回与参数关联的值 name.
- 加载参数()利息
从CGI环境变量request_方法、query_字符串和http_cookie初始化owsrequest对象。返回收集的名称/值对的数目。警告:大多数错误都会导致进程退出!
- loadparamsfromurl(字符串url)利息
从提供的URL初始化owsrequest对象,该URL被视为查询字符串。请注意,在这种情况下,请求_method=get且不假设post数据。此方法已添加到MapServer 6.0中。
- setParameter(字符串名称、字符串值)无效
设置请求参数。例如::
request.setParameter('REQUEST', 'GetMap') request.setParameter('BBOX', '-107.0,40.0,-106.0,41.0')
彭波托基¶
PointObj实例可能与LineObj关联:
+-------+ 1..* 0..1 +------+
| Point | <--------- | Line |
+-------+ +------+
PointObj属性¶
- 米浮动
措施。仅对测量的形状文件有意义。给定值-2E38,如果未另行指定,则表示“nodata”。
- X浮动
烘焙
- Y浮动
北方的
- Z浮动
高程
PointObj方法¶
- 新的PointObj([浮点X=0.0,浮点Y=0.0,浮点Z=0.0,浮点M=-2E38])彭波托基
创建新实例。Easting、Northing和Measure参数是可选的。
- 距离topoint(pointobj point)浮动
返回到的距离 点.
- 到段的距离(点obj点1,点obj点2)浮动
返回连接到假设线段的最小距离 point1 和 点数2.
- 形状的距离(shapeobj_uushape)浮动
返回最小距离 形状.
- 绘图(mapobj_uu map、layerobj_u layer、imageobj_u image、int classindex、字符串文本)利息
使用定义的样式绘制点 classindex 类 layer 并用字符串标记 text. 返回ms-success或ms-failure。
- 项目(ProjectionObj项目输入,ProjectionObj项目输出)利息
再投影点 proj_in 到 proj_out. 改造已经到位。返回ms-success或ms-failure。
- setxy(浮点数x,浮点数y[,浮点数m=2e-38])利息
同时设置空间坐标和(可选)测量值。只有当 m 大于ESRI测量值,没有1e-38的数据值。返回ms-success或ms-failure。
- setxyz(float x,float y,float z[,float m=-2E38])利息
同时设置空间坐标和(可选)测量值。只有当 m 大于ESRI测量值-1E38。返回ms-success或ms-failure。
- setxyzm(浮点数x、浮点数y、浮点数z、浮点数m)利息
同时设置空间坐标和(可选)测量值。只有当 m 大于ESRI测量值-1E38。返回ms-success或ms-failure。
- ToHaPe[())形状对象
方便的方法快速地将一个点转变成一个shapeobj。
- 托斯特林()一串
返回格式如下的字符串:
{ 'x': %f , 'y': %f, 'z': %f }
适当替换坐标值。python用户可以通过pointobj_uuu str_uuu方法获得相同的效果:
>>> p = mapscript.pointObj(1, 1) >>> str(p) { 'x': 1.000000 , 'y': 1.000000, 'z': 1.000000 }
投影对象¶
这个类还没有完全实现。MapServer的地图和图层具有投影属性,它们是C ProjectionObj结构,但不直接由MapScript模块公开。目前,我们必须做一些这样的循环逻辑:
point.project(projectionObj(mapobj.getProjection(),
projectionObj(layer.getProjection())
将点从地图投影到图层参照系统。
项目对象属性¶
- 努马格斯不可变的
项目参数数。
ProjectionObj方法¶
- 新项目OnObj(字符串Proj4)投影对象
创建ProjectionObj的新实例。输入参数 项目4 是项目定义字符串,如“init=EPSG:4269”。
- GETUNITSH()利息
返回投影对象的单位。出错时返回-1。
雷克托布杰¶
rectobj可以是一个单独的对象或另一个对象的属性,并且没有其他关联。
rectobj属性¶
- 马克斯浮动
最大产量
- 梅西浮动
最大北距
- 米克斯浮动
最低限额
- 米尼浮动
最小北距
ReCbTJ方法¶
- 新rectobj([float minx=-1.0,float miny=-1.0,float maxx=-1.0,float maxy=-1.0,int imageunits=ms_false])雷克托布杰
创建新实例。四个东距和北距参数是可选的,默认为-1.0。请注意新的可选第五个参数,它允许以图像(像素/线条)单位创建矩形,这些单位也进行了有效性测试。
- 绘制(mapobj_uu map、layerobj_u layer、imageobj_uuimg、int classindex、字符串文本)利息
将矩形绘制到 img 使用由定义的样式 classindex 类 图层. 矩形用字符串标记 text. 返回ms-success或ms-failure。
- GETCARTIN()彭波托基
返回矩形的中心点。
- 项目(ProjectionObj项目输入,ProjectionObj项目输出)利息
从中重新投影矩形 proj_in 到 proj_out. 改造已经到位。返回ms-success或ms-failure。
- TopyOng-()形状对象
转换为五个顶点的多边形。
- 托斯特林()一串
返回格式如下的字符串:
{ 'minx': %f , 'miny': %f , 'maxx': %f , 'maxy': %f }
适当替换边界值。python用户可以通过rectobj_uuu str_uuu方法获得相同的效果:
>>> r = mapscript.rectObj(0, 0, 1, 1) >>> str(r) { 'minx': 0 , 'miny': 0 , 'maxx': 1 , 'maxy': 1 }
参考对象AppObjt¶
referencemapobj与mapobj关联::
+--------------+ 0..1 1 +-----+
| ReferenceMap | <--------> | Map |
+--------------+ +-----+
referencemapobj属性¶
- color色度Objo
参考框的颜色。
- extent雷克托布杰
以父地图为单位的参考空间范围。
- 高度利息
参考地图的高度(像素)。
- 形象一串
参考地图图像的文件名。
- 地图:地图不可变MABOBJ不可变
对父mapobj的引用。
- 标记利息
地图符号集中用于标记的符号索引。
- 商标名一串
符号的名称。
- 标记尺寸利息
标记的大小。
- 最大尺寸利息
像素。
- 最小尺寸利息
像素。
- outlinecolor色度Objo
参考框的轮廓颜色。
- 地位利息
MS_ON 或 MS_OFF 。
- 宽度利息
以像素为单位。
referencemapobj方法¶
- 转换字符串()一串
将对象保存到字符串。为UpdateFromString提供反转选项。
6.4 新版功能.
结果缓存成员对象¶
与其他MapScript类没有关联,也没有方法。通过使用多个索引,resultCacheMemberObj引用了一个单层功能。
结果缓存成员对象属性¶
- 类别索引不可变的
已将功能分类到其中的图层类的索引。
- 形态指数不可变的
层内特征的索引。
- 倾斜指数不可变的
仅对平铺层有意义,shapefile数据平铺的索引。
结果对象¶
有关使用新的4.4查询API的额外指导,请参阅query-howto.txt。
结果缓存对象属性¶
- 边界:矩形不可变Rectobj不可变
查询结果的边界框。
- 数字结果不可变的
结果集的长度。
结果缓存对象方法¶
- 获取结果(int i)_结果缓存成员对象
返回索引处的结果 i, 与layerObj::GetResult类似,如果索引超出结果范围,则为空。
斯巴巴罗夫¶
scalebarobj与mapobj关联:
+----------+ 0..1 1 +-----+
| Scalebar | <--------- | Map |
+----------+ +-----+
还有Labelobj_uu::
+----------+ 1 1 +-------+
| Scalebar | ---------> | Label |
+----------+ +-------+
scalebarobj属性¶
- backgroundcolor色度Objo
比例尺背景色。
- color色度Objo
比例尺前景颜色。
- 高度利息
像素。
- imagecolor色度Objo
scaleBar的背景色。
- 间隔利息
间隔数。
- label拉贝洛夫
标尺标签。
- outlinecolor色度Objo
前景轮廓颜色。
- 位置利息
MS_UL, MS_UC, MS_UR, MS_LL, MS_LC, or MS_LR.
- 标签缓存利息
MS_TRUE 或 MS_FALSE 。
- 地位利息
MS_ON, MS_OFF, or MS_EMBED.
- 风格利息
0或1。
- 单位利息
请参阅mapserver.h中的ms_units。
- 宽度利息
像素。
scalebarobj方法¶
- 转换字符串()一串
将对象保存到字符串。为UpdateFromString提供反转选项。
6.4 新版功能.
SuffeFielObjo¶
shapefileobj属性¶
- bounds雷克托布杰
形状的范围。
- 数字利息
形状数。
- 类型利息
有关类型值,请参见mapshape.h。
shapefileobj方法¶
- new shapefileobj(字符串文件名[,int type=-1])SuffeFielObjo
创建新实例。省略 type 参数或使用值-1打开现有形状文件。
- 添加(shapeobj_uushape)利息
将形状添加到形状文件。返回ms-success或ms-failure。
- 获取(int i,shapeobj_uushape)利息
从索引获取shapefile功能 i 并将其存储在 形状. 返回ms-success或ms-failure。
- 获取形状(int i)_形状对象
返回索引i处的shapefile功能。比 get.
todo
形状对象¶
层数据的每个特征都是一个shapeobj。形状的每个部分都是一个封闭的线条obj:
+-------+ 1 1..* +------+
| Shape | --------> | Line |
+-------+ +------+
shapeobj属性¶
- bounds雷克托布杰
形状的边界框。
- 类别索引利息
分类层特征的类索引。
- 指数利息
层内的功能索引。
- 数字不可变的
零件数量。
- 数字不可变的
形状属性的数目。
- 文本一串
形状批注。
- 倾斜指数利息
平铺索引层的平铺文件索引。
- 类型利息
ms-shape_-point、ms-shape_-line、ms-shape_-polygon或ms-shape_-null。
shapeobj方法¶
- 新建shapeobj(int类型)形状对象
返回指定的新shapeobj type. 请参见上面的类型属性。默认情况下没有创建属性值。应显式调用initValues以创建所需数量的值。
- 添加(LineObj_uuLine)利息
添加 line (即零件)形状。返回ms-success或ms-failure。
- 边界()形状对象
返回现有形状的边界。需要地理位置支持。失败时返回null/undef。
- 缓冲区(int距离)形状对象
根据提供的距离(在现有shapeobj的坐标中给定)返回新的缓冲shapeobj。需要地理位置支持。失败时返回null/undef。
- 克隆()形状对象
返回形状的独立副本。
- 包含(PointObj_uuPoint)利息
如果点在形状内,则返回ms_true,否则返回ms_false。
- 包含(shapeobj shape2)利息
如果shape2完全在形状内,则返回ms_true。出错时返回-1,否则返回ms_false。需要地理位置支持。
- 凸出()形状对象
返回现有形状的凸面外壳。需要地理位置支持。失败时返回null/undef。
- 复制(shapeobj shape_copy)利息
将形状复制到 shape_copy. 返回ms-success或ms-failure。
- 交叉(shapeobj shape2)利息
如果shape2与形状交叉,则返回ms_true。出错时返回-1,否则返回ms_false。需要地理位置支持。
- 差异(shapeobj shape)形状对象
返回所提供形状和现有形状的计算差。需要地理位置支持。失败时返回null/undef。
- 不相交(shapeobj shape2)利息
如果形状2和形状不相交,则返回ms_true。出错时返回-1,否则返回ms_false。需要地理位置支持。
- 距离TOPINT(PointObj_uu Point)浮动
返回距离 点.
- 到形状的距离(形状obj形状)浮动
将最小距离返回到 形状.
- 绘制(MABOBJ UUUMAP、LAYEROBJ UUULAYER、IMAGEOBJ UUIMG)利息
使用图层绘制单个形状。返回ms-success或ms-failure。
- 等于(shapeobj shape2)利息
如果形状和形状2相等(仅限几何图形),则返回ms_true。出错时返回-1,否则返回ms_false。需要地理位置支持。
- FromWKT(字符*WKT)形状对象
基于几何图形的已知文本表示返回新的shapeobj。需要地理位置支持。失败时返回null/undef。
- 获取(int索引)_线路对象
返回对部件的引用 指数. 引用仅在shapeobj的生命周期内有效。
- GETRAIAL()双重的
返回形状的区域(如果适用)。需要地理位置支持。
- GETCCENRODIDER()彭波托基
返回现有形状的质心。需要地理位置支持。失败时返回null/undef。
- GETLIGHT()双重的
返回形状的长度(或周长)。需要地理位置支持。
- 获取值(int i)一串
返回索引处的形状属性 i.
- 初始值(int numvalues)无效
为请求的值数分配内存。
- 相交(shapeobj shape)利息
如果两个形状相交,则返回ms_true,否则返回ms_false。
注解
不需要地理支持,但如果可用,将使用地理功能。
- 交集(shapeobj shape)形状对象
返回所提供形状和现有形状的计算交集。需要地理位置支持。失败时返回null/undef。
- 重叠(shapeobj shape2)利息
如果shape2与形状重叠,则返回ms_true。出错时返回-1,否则返回ms_false。需要地理位置支持。
- 项目(ProjectionObj项目输入,ProjectionObj项目输出)利息
从中重新投影形状 proj_in 到 proj_out. 改造已经到位。返回ms-success或ms-failure。
- 设置界限无效
必须在添加新零件后调用以计算新边界框。
TODO:
- setvalue(int i,字符串值)利息
在索引处设置形状值 i 到 价值.
- 简化(双公差):shapeobj
给定公差后,返回简化的形状对象或出错时为空。需要地理支持(>=3.0)。
- 符号差分(shapeobj shape)形状对象
返回所提供形状和现有形状的计算对称差。需要地理位置支持。失败时返回null/undef。
- 拓扑保留简化(双公差):shapeobj
给定公差后,返回简化的形状对象或出错时为空。需要地理支持(>=3.0)。
- 触摸(shapeobj shape2)利息
如果形状和形状2接触,则返回ms_true。出错时返回-1,否则返回ms_false。需要地理位置支持。
- ToTKT()一串
返回shapeobj的已知文本表示形式。需要地理位置支持。失败时返回null/undef。
- 联合(shapeobj shape)形状对象
返回现有形状和提供的形状的联合。形状必须属于同一类型。需要地理位置支持。失败时返回null/undef。
- 内部(shapeobj shape2)利息
如果形状完全在shape2中,则返回ms_true。出错时返回-1,否则返回ms_false。需要地理位置支持。
样式对象¶
StyleObj的一个实例与ClassObj的一个实例相关联:
+-------+ 0..* 1 +-------+
| Style | <-------- | Class |
+-------+ +-------+
StyleObj的实例可以存在于ClassObj容器之外,并显式插入ClassObj以用于映射::
new_style = new styleObj()
the_class.insertStyle(new_style)
理解insertStyle插入 copy 对StyleObj实例的引用,而不是对实例本身的引用。
旧的用例:
new_style = new styleObj(the_class)
仍然支持。这些将是访问类样式的唯一方法。程序员不应该再直接访问Styles属性。
StyleObj属性¶
- 角双重的
角度,以度数表示,用于绘制线条。默认值为0。对于图案填充类型的符号,这是阴影线的角度。
- 盎格鲁项目一串
5.0 版后已移除: 使用SETIN绑定。
- backgroundcolor色度Objo
背景笔颜色。
- color色度Objo
前景或填充笔颜色。
- mincolor色度Objo
颜色范围映射的属性( MS RFC 6:连续特征值的颜色范围映射 )mincolor、minvalue、maxcolor和maxvalue定义了在地图上呈现特征时,将连续特征值映射到连续颜色范围的范围。
- 最小尺寸利息
缩放样式的最小笔或符号宽度。
- 最小值双重的
颜色范围映射的属性( MS RFC 6:连续特征值的颜色范围映射 )mincolor、minvalue、maxcolor和maxvalue定义了在地图上呈现特征时,将连续特征值映射到连续颜色范围的范围。
- 最小宽度利息
符号的最小宽度。
- maxcolor色度Objo
颜色范围映射的属性( MS RFC 6:连续特征值的颜色范围映射 )mincolor、minvalue、maxcolor和maxvalue定义了在地图上呈现特征时,将连续特征值映射到连续颜色范围的范围。
- 最大尺寸利息
用于缩放的最大笔或符号宽度。
- 最大值双重的
颜色范围映射的属性( MS RFC 6:连续特征值的颜色范围映射 )mincolor、minvalue、maxcolor和maxvalue定义了在地图上呈现特征时,将连续特征值映射到连续颜色范围的范围。
- 最大宽度利息
符号的最大宽度。
- 偏移量x利息
使用笔或符号从地图数据偏移绘制。
- 杂乱利息
使用笔或符号从地图数据偏移绘制。
- outlinecolor色度Objo
轮廓笔颜色。
- 模式双值数组
用于定义线条工作(线条、多边形轮廓、阴影线等)的虚线图案的开、关值列表。
- 花纹长度利息
模式属性中的元素数。
- 测距项一串
存储颜色范围映射值的属性/字段( MS RFC 6:连续特征值的颜色范围映射 )
- 大小利息
样式笔或符号的像素宽度。
- 尺寸项目一串
5.0 版后已移除: 使用SETIN绑定。
- 符号利息
样式符号的映射符号集中的索引。
- 符号名字符串不可变
样式符号的名称。
- 宽度利息
宽度是指以像素为单位绘制的线条的厚度。默认值为1。对于“图案填充”类型的符号,with是阴影线的厚度。
StyleObj方法¶
- 新建StyleObj([ClassObj_uuParent_Class])样式对象
返回新的默认样式obj实例。这个 parent_class 是可选的。
- 克隆样式对象
返回没有父类的样式的独立副本。
- 转换字符串()一串
将对象保存到字符串。为UpdateFromString提供反转选项。
6.4 新版功能.
- getbinding(int绑定)一串
获取指定样式属性的属性绑定。如果此属性没有绑定,则返回空值。
- removebinding(int绑定)利息
删除specField样式属性的属性绑定。
- setbinding(int绑定,字符串项)利息
为指定的样式属性设置属性绑定。绑定常量如下所示:ms_-style_-binding_uu[attribute name]:
setBinding(MS_STYLE_BINDING_SIZE, 'mySizeItem');
- setsymbolbyname(mapobj_uu map,字符串符号名)利息
设置StyleObj的符号,给出了映射对象的引用和符号名称。
- updatefromstring(字符串片段)利息
从字符串片段更新样式。返回ms-success/ms-failure。
符号对象¶
符号对象与一个符号对象相关联:
+--------+ 0..* 1 +-----------+
| Symbol | <-------- | SymbolSet |
+--------+ +-----------+
StyleObj通常按名称或索引引用符号obj,但这实际上不是对象关联,是吗?
符号对象属性¶
- 反别名利息
MS_TRUE 或 MS_FALSE 。
- 性格一串
对于TrueType符号。
- 填满利息
MS_TRUE 或 MS_FALSE 。
- 字体一串
对于TrueType符号。
- 缺口利息
走向风格
- 意象派一串
pixmap文件的路径。
- Mapfile利息
如果设置为真,符号将保存在 Mapfile 中。在MapServer 5.6.1中添加
- 直线加速器利息
走向风格
- 线条连接利息
走向风格
- 线性连接最大尺寸浮动
走向风格
- 名称一串
符号名
- 点数不可变的
矢量符号的点数。
- 位置利息
没有更多可用的?
- 西泽浮动
TODO 这是什么?
- 西齐浮动
TODO 这是什么?
- 字长利息
间隔数
- 透明的利息
TODO 这是什么?
- 透明色利息
TODO 这是一个废弃属性吗?
- 类型利息
ms_-symbol_-simple、ms_-symbol_-vector、ms_-symbol_-椭圆、ms_-symbol_-pixmap或ms_-symbol_-truetype。
符号对象方法¶
- 新符号obj(字符串符号名称[,字符串图像文件])符号对象
创建名为的新默认符号 name. 如果 imagefile 如果指定了,则符号的类型将为ms_symbol_pixmap。
- GeTimeGe()图像对象
以imageobj的形式返回pixmap符号的图像。
- GooPosits()线路对象
将符号点作为LineObj返回。
- setimage(图像对象图像)利息
设置像素地图符号的图像来自 形象.
- 设定点(lineobj_uu line)利息
从以下点设置符号点: line. 返回更新的点数。
- 设置样式(int index,int value)利息
将样式设置为 index 到 价值. 返回ms-success或ms-failure。
符号集对象¶
符号etobj是mapobj的一个属性,它与符号obj的实例相关联:
+-----------+ 1 0..* +--------+
| SymbolSet | --------> | Symbol |
+-----------+ +--------+
符号对象属性¶
- 文件名一串
符号集文件名
- 数字符号不可变的
集合中的符号数。
symbolsetobj方法¶
- 新符号etobj([字符串符号文件])符号集对象
创建新实例。如果 symbolfile 如果指定,符号将从文件加载。
- 附录符号(符号obj_u符号)利息
添加一份 symbol 并返回其索引。
- 获取符号(int index)_符号对象
返回对位于的符号的引用 指数.
- GetSymbolByName(字符串名称)_符号对象
返回对名为 name.
- 索引(字符串名称)利息
返回名为的符号的索引 name 或-1,如果未找到此类符号。
- 删除符号(int index)_符号对象
删除处的符号 index 并返回符号的副本。
- 保存(字符串文件名)利息
将符号集保存到文件。返回ms-success或ms-failure。
韦博伊¶
除了作为mapobj的属性之外,没有其他存在。用作各种运行时Web应用程序定义(如临时文件路径、模板路径等)的容器。
Webobj属性¶
- 空的一串
TODO
- 错误一串
TODO
- extent雷克托布杰
剪切范围。
- 页脚一串
页脚文档的路径。
- 页眉一串
标题文档的路径。
- 意象派一串
临时映像位置的文件系统路径。
- 意象派一串
临时图像位置的URL。
- 日志一串
TODO
- 地图MABOBJ不可变
对父mapobj的引用。
- 最大刻度浮动
最小地图比例尺。
- 最大模板一串
TODO
- 元数据:hashtableobj_uu不可变hashtableobj不可变
元数据哈希表。
- 最小尺度浮动
最大地图比例尺。
- 微型模板一串
TODO
- 查询格式一串
TODO
- 模板一串
模板文档的路径。
Webobj方法¶
- 转换字符串()一串
将对象保存到字符串。为UpdateFromString提供反转选项。
6.4 新版功能.