FeatureState¶
特定のフィーチャに独自のプロパティを割り当てる。
スタイルで ["feature-state", "prop-name"] のような式を評価すると、
そのフィーチャーに対する FeatureState インスタンスに設定した
"prop-name" プロパティの値が得られる。
ただし "prop-name" プロパティが存在しないとき、またはフィーチャーに
対する FeatureState インスタンスが存在しないときは null が得られる。
FeatureState インスタンスは [[StyleManager.ensureFeatureState]]
により生成することができる。
Properties¶
feature_id¶
readonlyfeature_id:number
対応するフィーチャの ID
style_manager¶
readonlystyle_manager:StyleManager
起源となる [[StyleManager]] インスタンス
Accessors¶
num_properties¶
getnum_properties():number
保有するプロパティの数
Returns¶
number
Methods¶
clearProperties()¶
clearProperties():
void
所有するすべてのプロパティを削除する。
Returns¶
void
deleteProperty()¶
deleteProperty(
pid):void
指定したプロパティを削除する。
pid に対応するプロパティを削除する。
そのプロパティが存在しなければ何もしない。
Parameters¶
| Parameter | Type |
|---|---|
pid |
string |
Returns¶
void
getPropertyIds()¶
getPropertyIds():
IterableIterator<string>
所有するプロパティの ID を列挙するオブジェクトを取得する。
Returns¶
IterableIterator<string>
getValue()¶
getValue(
pid):unknown
プロパティの値を取得する。
pid に対応するプロパティの値を取得する。
プロパティが存在しない場合は undefined を返す。
Parameters¶
| Parameter | Type |
|---|---|
pid |
string |
Returns¶
unknown
hasProperty()¶
hasProperty(
pid):boolean
指定したプロパティの所有を確認する。
pid に対応するプロパティを所有していれば true, 所有していな
ければ false を返す。
Parameters¶
| Parameter | Type |
|---|---|
pid |
string |
Returns¶
boolean
setValue()¶
setValue(
pid,value):void
プロパティの値を設定する。
pid に対応するプロパティの値を value に設定する。
プロパティが存在しないときは、新規にプロパティを生成して値を
value に設定する。
Parameters¶
| Parameter | Type |
|---|---|
pid |
string |
value |
unknown |
Returns¶
void
Remarks¶
value はそのまま this に保持される (複製されない) ので、value が
参照型のときはその内容を変更しないこと。