+-----+ 0..1 0..* +-------+
| Map | <--------> | Layer |
+-----+ +-------+
+-----+ 1 0..1 +--------------+
| Map | ---------> | Legend |
+-----+ | ------------ |
| Scalebar |
| ------------ |
| ReferenceMap |
+--------------+
+-----+ 1 1..* +--------------+
| Map | ---------> | OutputFormat |
+-----+ +------------- +
4.14.1 mapObj 属性
cellsize : float
Pixel size in map units.
configoptions : hashObj immutable
マップファイルのCONFIGで設定されたオプションのハッシュテーブルです。直接設定オプションにアクセスのは非推奨です、代わりにsetConfigOption()とgetConfigOption()を利用してください。
datapattern : string
これはURLリクエスト経由で送られてくるDATAパラメータ(すなわちmap_layername_data=である)へ適用して変化させる目的で適用される正規表現を定義する。パターンが存在しなければ、web上のユーザはサポートのためのファイル(訳注:設定ファイル群のことか?)をURL経由でさわることができないであろう。あなたが望むならば、これはあなたに一つのアプリケーションをデフォルトで非常に保守的な運用がなされる他のアプリケーションから隔離することを可能にする。 TEMPLATEPATTERNも参照のこと。
debug : int
MS_TRUE或いはMS_FALSE.
extent : rectObj
地図が生成される際の空間的な範囲。
fontset : fontSetObj immutable
使用するフォントセットファイルの完全な名称。
height : int
地図出力画像の高さです。単位はpixels。
MapserverV4.4より、直接高さを設定するのは非推奨となって、代わりにsetSize()メソッドを利用してください。
imagecolor : colorObj
地図を初期化する色(すなわち背景色)。
imagequality : int
JPEG出力の圧縮レベルを設定する。
MapserverV4.4より、非推奨となって、代わりOUTPUTFORMATを利用してください。
imagetype : string immutable
生成される画像の出力フォーマット。
interlace : int
出力イメージがインターレースかどうかを設定する。
MapserverV4.4より、非推奨となって、代わりOUTPUTFORMATを利用してください。
lablecache : labelCacheObj immutable
labelcacheの参照です。
legend : legendObj immutable
legendの参照です。
mappath : string
マップファイルの物理場所です。
maxsize : int
作成された画像の最大サイズである。
name : string
マップの名前。
numlayers : int immutable
マップ内含まれたレイヤの数です。
numoutputformats : int
マップ内含まれたoutputformatの数です。
outputformat : outputFormatObj
現在選択されたoutputformatです。マップのoutputformatを直接の修正がよろしくないので、代わりにselectOutputFormat()メソッドを利用してください。
outputformatlist : outputFormatObj[]
すべてoutputformatの配列です。
querymap : queryMapObj immutable
queryMapObjの参照です。
reference : referenceMapObj immutable
referenceMapObjの参照です。
resolution : float
出力でのインチあたりのピクセル数を設定する。デフォルトは72です。
scale : float
地図のスケールです。例：25000の意味は1:25000です。
scalebar : scalebarObj immutable
scalebarObjの参照です。
shapepath : string
シェイプファイルを保持するディレクトリへのパス。
status : int
地図がアクティブかどうか。MS_OFF, MS_ON或いはMS_DEFAULT。
symbolset : symbolSetObj immutable
symbolSetObjの参照です。
templatepattern : string
これはURLリクエスト経由で送られてくるDATAパラメータ(すなわちmap_layername_template=である)へ適用して変化させる目的で適用される正規表現を定義する。パターンが存在しなければ、web上のユーザはサポートのためのファイル(訳注:設定ファイル群のことか?)をURL 経由でさわることができないであろう。あなたが望むならば、これはあなたに一つのアプリケーションをデフォルトで非常に保守的な運用がなされる他のアプリケーションから隔離することを可能にする。 DATAPATTERNも参照のこと。
transparent : int
背景色を透過色として用いるかどうか。MS_TRUE或いはMS_FALSE。
MapserverV4.4より、非推奨となって、代わりOUTPUTFORMATを利用してください。
units : int
地図の座標系での単位。MS_DD, MS_METERSなど。
web : webObj immutable
webObjの参照です。
width : int
地図出力画像の幅です。
4.14.2 mapObj メソッド
new mapObj( [ string filename='' ] ) : mapObj
mapObjインスタンスを新規作成します。
appendOutputFormat( outputFormatObj format ) : int
マップにoutputFormatObjオブジェクトを追加します。
applyConfigOptions( ) : void
setConfigOption()メソッドで設定したオプションを適用します。
applySLD( string sldxml ) : int
SLD XMLを適用します。MS_SUCCESS或いはMS_FAILUREを返します。
applySLDURL( string sldurl ) : int
SLD XMLのURLを与えて、SLDを適用します。MS_SUCCESS或いはMS_FAILUREを返します。
clone( ) : mapObj
mapObjインスタンスのコピーを作成します。
注：Javaモジュールの場合はメソッドの名前はcloneMap()となります。
draw( ) : imageObj
地図を描画し、イメージオブジェクトのハンドルを返します。
drawLabelCache( imageObj image ) : int
地図のラベルをレンダリングします。MS_SUCCESS或いはMS_FAILUREを返します。
drawLegend( ) : imageObj
凡例を描画し、イメージオブジェクトのハンドルを返します。
drawQuery( ) : imageObj
照会結果地図を描画し、イメージオブジェクトのハンドルを返します。
drawReferenceMap( ) : imageObj
リファレンスマップを描画し、イメージオブジェクトのハンドルを返します。
drawScalebar( ) : imageObj
スケールバーを描画し、イメージオブジェクトのハンドルを返します。
embedLegend( imageObj image ) : int
凡例を組み込みます。実際には凡例はラベルキャッシュに追加されるだけなので、drawLabelCache() を呼び出してレンダリングする必要があります。
MS_SUCCESS或いはMS_FAILUREを返します。
embedScalebar( imageObj image ) : int
スケールバーを組み込みます。実際にはスケールバーはラベルキャッシュに追加されるだけなので、drawLabelCache() を呼び出してレンダリングする必要があります。
MS_SUCCESS或いはMS_FAILUREを返します。
freeQuery( [ int qlayer=-1 ] ) : void
指定したレイヤの照会結果を解放します。-1を指定すると、すべてのレイヤの照会が解放されます。
generateSLD( ) : string
マップレイヤのSLD XMLを返します。
getConfigOption( string key ) : string
キーと関連した構成の値を返します。キー存在しない場合は、空文字列を戻ります。
getFirstMetaDataKey( ) : string
メタデータハッシュテーブル内の最初のキーを返します。getNextMetaDataKey()でその他のキーも取得できます。
getLayer( int index ) : layerObj
indexを与えてmapからlayerObjを返します。（0＝最初のレイヤ）
getLayerByName( string name ) : layerObj
layer_nameを与えてmapからlayerObjを返します。
getLayersDrawingOrder( ) : int
描画順でレイヤのインデックス配列を返します。
getMetaData( string key ) : string
metadataエントリーをnameによってフェッチします。
getNextMetaDataKey( string lastkey ) : string
メッタハッシュテーブルの次のキーを返します、次のキーは最後のキーになる場合は、NULLを戻ります。
最後のキーはNULLになった場合は、繰り返し最初のキーを返します。
getNumSymbols( ) : int
定義されたシンボルの数を返します。
getOutputFormatByName( string imagetype ) : outputFormatObj
imagetypeを与えて、outputFormatObjの参照を返します。
getProjection( ) : string
投影の文字列表現を返します。
getSymbolByName( string name ) : int
名前を使ってシンボル・インデックスを返します。
insertLayer( layerObj layer [, int nIndex=-1 ] ) : int
レイヤのコピーをマップに追加します。nIndexを指定された場合は、指定されたポジションに追加します。新レイヤのインデックスを返します。
loadMapContext( string filename [, int useUniqueNames=MS_FALSE ] ) : int
OGCマップコンテンツファイルをロードします。
loadOWSParameters( OWSRequest request [, string version='1.1.1' ] ) : int
OWSrequest パラメータをロードします。(BBOX, LAYERSなど)。MS_SUCCESS或いはMS_FAILUREを返します。
loadQuery( string filename ) : int
現在の照会をファイルからロードします。MS_SUCCESSまたはMS_FAILUREが返ります。
moveLayerDown( int layerindex ) : int
レイヤを描画階層の中で繰り下げます。MS_SUCCESS或いはMS_FAILUREを返します。
moveLayerUp( int layerindex ) : int
レイヤを描画階層の中で繰り上げます。MS_SUCCESS或いはMS_FAILUREを返します。
nextLabel( ) : labelCacheMemberObj
ラベルキャッシュから次のラベルを返します。
OWSDispatch( OWSRequest req ) : int
転送されたOpenGIS Web Services請求を処理＆実行します。
reqオブジェクト内に正しいOWS請求が存在しない場は、MS_DONE (2)を戻ります。
OWS請求が正常に処理された場合はMS_SUCCESS (0)、失敗の場合はMS_FAILURE (1)を戻ります。
OWS請求はWMS, WFS,WCS and SOSを含んでいます、
prepareImage( ) : imageObj
空のイメージオブジェクトのハンドルを返します。
prepareQuery( ) : void
地図の縮尺を計算し、map->scaleに割り当てます。
processLegendTemplate( string names[], string values[], int numitems ) : string
凡例テンプレートファイルを処理し、結果をバッファに返します。
processQueryTemplate( string names[], string values[], int numitems ) : string
照会テンプレートファイルを処理し、結果をバッファに返します。
processTemplate( int generateimages, string names[], string values[], int numitems ) : string
webオブジェクトに指定されたテンプレートファイルを処理し、結果をバッファに返します。
queryByFeatures( int layerindex ) : int
レイヤからの、先の結果セットに基づいて照会を実行します。結果セットは現時点ではポリゴンレイヤにもとづいていなければなりません。
形状が見つかった場合、MS_SUCCESSが返ります。何も見つからないか、何らかのエラーが発生した場合、MS_FAILUREが返ります。
queryByPoint( pointObj point, int mode, float buffer ) : int
mapの全選択レイヤを地理座標（すなわち、ピクセルではありません）で指定されたポイントで照会します。
照会は、TEMPLATEに値が入っているクラス、または、所属するレイヤのTEMPLATEに値が入っているクラスに属するすべての形状に対して実行されます。 modeは欲しい結果数によって、MS_SIGLEまたはMS_MULTIPLEを指定します。 bufferを<=0としてマップファイルで設定したデフォルトのtolerance（ピクセル単位で指定）を使うか、一定の大きさのbuffer （地上の距離単位で指定）を使用できます。
形状が見つかった場合、MS_SUCCESSが返ります。何も見つからないか、何らかのエラーが発生した場合、MS_FAILUREが返ります。
queryByRect( rectObj rect ) : int
mapの全選択レイヤを地理座標（すなわち、ピクセルではありません）で指定された矩形を使って照会します。
照会は、TEMPLATEに値が入っているクラス、または、所属するレイヤのTEMPLATEに値が入っているクラスに属するすべての形状に対して実行されます。形状が見つかった場合、MS_SUCCESSが返ります。何も見つからないか、何らかのエラーが発生した場合、MS_FAILUREが返ります。
queryByShape( shapeObj shape ) : int
mapの全選択レイヤを単一の形状に基づいて照会します。形状は現時点ではポリゴンでなければなりません。
形状が見つかった場合、MS_SUCCESSが返ります。何も見つからないか、何らかのエラーが発生した場合、MS_FAILUREが返ります。
removeLayer( int index ) : int
インデックスを与えて、レイヤを削除します。
removeMetaData( string key ) : int
メタデータのキーを与えて、メタデータアイテムを削除します。MS_SUCCESS或いはMS_FAILUREを返します。
removeOutputFormat( string name ) : int
OutputFormatの名前を与えて、OutputFormatを削除します。MS_SUCCESS或いはMS_FAILUREを返します。
save( string filename ) : int
現在のmapオブジェクトの状態をファイルに保存します。MS_SUCCESS或いはMS_FAILUREを返します。
saveMapContext( string filename ) : int
OGC-compliant XMLでマップコンテンツを保存します。MS_SUCCESS或いはMS_FAILUREを返します。
saveQuery( string filename ) : int
現在の照会をファイルに保存します。MS_SUCCESSまたはMS_FAILUREが返ります。
saveQueryAsGML( string filename ) : int
GMLで現在の照会をファイルに保存します。MS_SUCCESSまたはMS_FAILUREが返ります。
selectOutputFormat( string imagetype ) : void
mapで使われるoutputformatを選択します。
setConfigOption( string key, string value ) : void
構成の値を設定します。
setExtent( float minx, float miny, float miny, float maxy ) : int
mapのextentを、引数の地理座標範囲を使って設定します。MS_SUCCESSまたはMS_FAILUREが返ります。
setFontSet( string filename ) : int
新しいフォントセットをロードし設定します。すでにロードされたフォントはクリアされます。MS_SUCCESSまたはMS_FAILUREが返ります。
setImageType( string name ) : void
selectOutputFormat()を利用してください。
setLayersDrawingOrder( int layerindexes[]) : int
レイヤ順の配列を設定します。
setMetaData( string key, string value ) : int
mapのmetadataエントリーを設定します。MS_SUCCESSまたはMS_FAILUREが返ります。
setOutputFormat( outputFormatObj format ) : void
マップoutputformatを設定します。
setProjection( string proj4 ) : int
mapの投影と座標系を設定します。
setRotation( float rotation_angle ) : int
地図回転角度を設定する。地図表示長方形は、反時計回りの方向で示された角度によって回転します。
戻り値：MS_SUCCESS or MS_FAILURE
setSize( int width, int height ) : int
地図の高さと幅を設定する。このメソッドは内部のgeotransformと地図回ための他のデータ構造を更新します、その為、それが直接幅と高さメンバーを配置する代わりに、使われなければなりません。
戻り値：MS_SUCCESS or MS_FAILURE
setSymbolSet( string filename ) : int
シンボルファイルを動的にロードし設定します。すでにロードされているシンボルはクリアされます。MS_SUCCESSまたはMS_FAILUREが返ります。
setWKTProjection( string wkt ) : int
setProjection() と同様ですが、入力がOGC WKTの投影定義文字列となります。
zoomPoint( int zoomfactor, pointObj imgpoint, int width, int height, rectObj extent, rectObj maxextent ) : int
与えられたXY位置までズームします。
引数は：
- zoomfactor：正数ではズームイン、負数ではズームアウト。1はリセンター。
- Pixel position (pointObj)：左上を(0, 0)とした、クリック地点のx、y座標。
- Width：ピクセルで表した現在のイメージの幅。
- Height：ピクセルで表した現在のイメージの高さ。
- extent (rectObj) : 現在の地理座標範囲。
- maxextent (rectObj)：（オプション）最大地理座標範囲。指定した場合、この範囲を超えたズーム／パンはできない。
zoomRectangle( rectObj imgrect, int width, int height, rectObj extent, rectObj maxextent ) : int
mapのextentを与えられた範囲に設定します。
引数は：
- imgrect (rectObj)：左上を(0, 0)としたピクセル範囲。矩形にはLLとURの座標をピクセルで含みます。（rectオブジェクトのmaxyは< minyでなければなりません）
- Width：ピクセルで表した現在のイメージの幅。
- Height：ピクセルで表した現在のイメージの高さ。
- extent (rectObj)：現在の地理座標範囲。
zoomScale( float scale, pointObj imgpoint, int width, int height, rectObj extent, rectObj maxextent) : int
与えられたXY位置までズームインまたはズームアウトして、地図を指定したスケールで表示します。
引数は：
- Scale：地図を表示するスケール。
- imgpoint (pointObj)：左上を(0, 0)とした、クリック地点のx、y座標。
- Width：ピクセルで表した現在のイメージの幅。
- Height：ピクセルで表した現在のイメージの高さ。
- extent (rectObj)：現在の地理座標範囲。
- maxextent(rectObj)：（オプション）最大地理座標範囲。指定した場合、この範囲を超えたズーム／パンはできない。
