Class FeatureState

特定のフィーチャに独自のプロパティを割り当てる。

スタイルで ["feature-state", "prop-name"] のような式を評価すると、 そのフィーチャーに対する FeatureState インスタンスに設定した "prop-name" プロパティの値が得られる。

ただし "prop-name" プロパティが存在しないとき、またはフィーチャーに 対する FeatureState インスタンスが存在しないときは null が得られる。

FeatureState インスタンスは StyleManager.ensureFeatureState により生成することができる。

Hierarchy

  • FeatureState

Constructors

constructor

Properties

_pid_set feature_id style_manager

Accessors

num_properties

Methods

clearProperties deleteProperty getPropertyIds getValue hasProperty setValue

Constructors

Private constructor

Properties

Private Readonly _pid_set

_pid_set: Set<string>

Readonly feature_id

feature_id: number

対応するフィーチャの ID

Readonly style_manager

style_manager: StyleManager

起源となる StyleManager インスタンス

Accessors

num_properties

Methods

clearProperties

deleteProperty

  • 指定したプロパティを削除する。

    pid に対応するプロパティを削除する。

    そのプロパティが存在しなければ何もしない。

    Parameters

    • pid: string

    Returns void

getPropertyIds

getValue

  • プロパティの値を取得する。

    pid に対応するプロパティの値を取得する。

    プロパティが存在しない場合は undefined を返す。

    Parameters

    • pid: string

    Returns unknown

hasProperty

  • 指定したプロパティの所有を確認する。

    pid に対応するプロパティを所有していれば true, 所有していな ければ false を返す。

    Parameters

    • pid: string

    Returns boolean

setValue

  • プロパティの値を設定する。

    pid に対応するプロパティの値を value に設定する。

    プロパティが存在しないときは、新規にプロパティを生成して値を value に設定する。

    Remarks

    value はそのまま this に保持される (複製されない) ので、value が 参照型のときはその内容を変更しないこと。

    Parameters

    • pid: string
    • value: unknown

    Returns void

Settings

Member Visibility

Theme