classObjインスタンスはlayerObjインスタンスと関連します。
+-------+ 0..* 1 +-------+
| Class | <--------> | Layer |
+-------+ +-------+
その他classObjの重要な組合はstyleObj、labelObjとhashTableObj。
+-------+ 1 0..* +-------+
| Class | ---------> | Style |
+-------+ +-------+
+-------+ 1 0..1 +-------+
| Class | ---------> | Label |
+-------+ +-------+
+-------+ 1 1 +-----------+
| Class | ---------> | HashTable |
+-------+ | -- |
| metadata |
+-----------+
MapServer V4.1より、複数クラススタイルを設定することが可能になりました。詳細はstyleObjを参照してください。
4.1.1 classObj属性
debug : int
MS_TRUE or MS_FALSE
keyimage : string
TODO
label : labelObj immutable
ラベルクラスの定義です。
layer : layerObj immutable
親レイヤへの参照です。
maxscale : float
このクラス描画する最大縮尺です。
metadata : hashTableObj immutable
このクラスのメッタハッシュテーブルです。
minscale : float
このクラス描画する最小縮尺です。
name : string
レイヤ内でユニークの文字列です。
numstyles : int
このクラス内のスタイル数です。
status : int
MS_ON或いはMS_OFF。このクラスに含まれているフィーチャーを表示/非表示のフラグです。
template : string
検索結果用のテンプレートです。
title : string
凡例表示用のテキストです。
type : int
親レイヤのレイヤタイプです。
4.1.2 classObjメソッド
new classObj( [ layerObj parent_layer=NULL ] ) : classObj
親レイヤインスタンス内にclassObjを新規作成して、既存クラス配列の最後に追加します。レイヤパラメータを指定により、親レイヤ以外のレイヤにもクラスインスタンスの作成が可能です。
clone( ) : classObj
独立のコピーを返します、返したコピーが親レイヤが持っていません。
createLegendIcon( mapObj map, layerObj layer, int width, int height ) : imageObj
凡例アイコンを作成して、imageObjを返します。
drawLegendIcon( mapObj map, layerObj layer, int width, int height, imageObj image, int dstx, int dsty ) : int
指定されたイメージに(dstx, dsty)のところで凡例アイコンを描画します。戻り値はMS_SUCCESS或いはMS_FAILURE。
getExpressionString() : string
クラスオブジェクトのexpression文字列を返します。
getFirstMetaDataKey() : string
メッタハッシュテーブルから、最初のキーを返します。getNextMetaDataKey()でその他のキーも取得できます。
getMetaData( string key ) : string
キーを与えて、メッタハッシュテーブル内に該当値を返します。
getNextMetaDataKey( string lastkey ) : string
メッタハッシュテーブルの次のキーを返します、次のキーは最後のキーになる場合は、NULLを戻ります。
最後のキーはNULLになった場合は、繰り返し最初のキーを返します。
注意
現時点、getFirstMetaDataKey(), getMetaData()とgetNextMetaDataKey()は非推奨となっています、将来的に削除される可能性があります。代わりに直接metadataをアクセスしてください。hashTableObjを参照してください。
getStyle( int index ) : styleObj
インデックスを与えて、styleObjオブジェクトを返します。
getTextString() : string
Return a string representation of the text enclosed in the quote characters appropriate to the text expression type (logical or simple string).
insertStyle( styleObj style [, int index=-1 ] ) : int
引数indexは指定された位置にstyleのコピーを追加します。indexのディフォルト値は-1、配列の最後になります。
追加されたstyleの実際のインデックスを返します。
moveStyleDown( int index ) : int
indexで指定したstyleObjのインデックスを+１にします。
moveStyleUp( int index ) : int
indexで指定したstyleObjのインデックスを-１にします。
removeStyle( int index ) : styleObj
indexを与えて、該当styleObjを削除して、削除されたstyleObjのコピーを返します。
setExpression( string expression ) : int
クラスオブジェクトのexpression文字列を設定します。戻り値はMS_SUCCESS或いはMS_FAILUIRE。
setMetaData( string key, string value ) : int
classObjのmetadataに項目を追加します。戻り値はMS_SUCCESS或いはMS_FAILUIRE。
注意
現時点、setMetaData()メソッドは非推奨となっています、将来的に削除される可能性があります。代わりに直接metadataをアクセスしてください。hashTableObjを参照してください。
setText( string text ) : int
Set text string where text is a MapServer text expression. 戻り値はMS_SUCCESS或いはMS_FAILUIRE。
