コンテンツにスキップ

StyleManager

ベクトル地図のスタイル全体を管理する。

[[create]] メソッドにより StyleManager インスタンスを生成すること ができる。

以下は、すべてのレイヤータイプで共通に使用できるプロパティである。

  • id
  • type
  • source
  • source-layer
  • filter
  • minzoom
  • maxzoom

ただし現在のところ、スタイルに指定できるレイヤーの type は symbol のみで、それ以外を type に設定しても、そのレイヤーは無視される。

symbol レイヤー専用のプロパティで使用できるものは以下のものに限られ、 それ以外のプロパティは設定しても無視される。

  • layout.text-field
  • layout.text-size
  • layout.text-font
  • layout.text-anchor
  • layout.text-offset
  • paint.text-color
  • paint.text-opacity
  • paint.text-halo-color
  • paint.text-halo-width
  • layout.icon-image
  • layout.icon-size
  • layout.icon-anchor
  • layout.icon-offset
  • paint.icon-color
  • paint.icon-opacity
  • paint.icon-halo-color
  • paint.icon-halo-width

layout.text-field プロパティは文字列のみを指定することができ、 formatted 型の値を指定することはできない。

See

[[Viewer.setVectileManager]]

Feature State

clearFeatureStates()

clearFeatureStates(): void

保有する [[FeatureState]] インスタンスをすべて削除する。

削除された [[FeatureState]] インスタンスは無効となり、どのよう な操作も行えなくなる。

Returns

void

ensureFeatureState()

ensureFeatureState(fid): FeatureState

指定 ID の [[FeatureState]] インスタンスを確保する。

フィーチャ ID が fid であるフィーチャのための [[FeatureState]] インスタンスを確保する。

具体的には、インスタンスがすでに存在すれば取得して、存在しなけ れば生成して返す。

Parameters

Parameter Type
fid number

Returns

FeatureState

getFeatureState()

getFeatureState(fid): undefined | FeatureState

指定 ID の [[FeatureState]] インスタンスを取得する。

フィーチャ ID が fid であるフィーチャのための [[FeatureState]] インスタンスを取得する。

インスタンスが存在しなければ undefined を返す。

Parameters

Parameter Type
fid number

Returns

undefined | FeatureState

getFeatureStates()

getFeatureStates(): IterableIterator<FeatureState>

保有する [[FeatureState]] インスタンスを列挙するオブジェクトを 取得する。

Returns

IterableIterator<FeatureState>

Image

addImage()

addImage(id, src_image, options?): void

画像を追加する。

src_image を元にした画像を this に追加する。

追加した画像の ID は id となる。

Parameters

Parameter Type Description
id string 画像の ID
src_image ImageSource 元画像
options? ImageOption 追加オプション

Returns

void

Throws

Error すでに id の画像が this に存在するとき。

getImageIDs()

getImageIDs(): IterableIterator<string>

すべての画像の ID を取得する。

this が持つすべての画像の ID に対する、反復可能な反復子オブジェクトを返す。

Returns

IterableIterator<string>

画像 ID の反復可能な反復子オブジェクト

hasImage()

hasImage(id): boolean

画像の有無を確認する。

ID が id である画像が this に存在するかどうかを確認する。

Parameters

Parameter Type Description
id string 画像の ID

Returns

boolean

存在するとき true, それ以外のとき false

removeImage()

removeImage(id): void

画像を削除する。

ID が id である画像を this から削除する。

id の画像が this に存在しないときは何も行わない。

Parameters

Parameter Type Description
id string 画像の ID

Returns

void

Remarks

画像を this から削除した後に、[[addImage]] により ID が id である別の画像を this に追加することができる。

Other

create()

static create(viewer, json_style, provider_factory): RequestResult<StyleManager>

インスタンスを生成する。

生成された [[StyleManager]] インスタンスは viewer にのみ設定 することができる。

例外のスローは Promise の拒否を通して通知される。

Parameters

Parameter Type Description
viewer Viewer 設定することが可能な [[Viewer]] インスタンス
json_style OJson JSON 形式のスタイルデータ
provider_factory ProviderFactory プロバイダを生成するためのオブジェクト

Returns

RequestResult<StyleManager>

リクエスト結果

Throws

Error

  • あるレイヤーの source プロパティに対するソース情報が存在し なかったとき

  • あるレイヤーの source プロパティに対するソース情報からプロ バイダを生成することができなかった

  • 何れかのソースに対するメタ情報を取得することができなかったとき

  • スプライトのリソースを取得することができなかったとき

  • レイヤーモジュールの初期化に失敗したとき

Throws

SyntaxError

json_style の構造がスタイルのスキーマに適合しないとき。

See

[[Viewer.setVectileManager]]

deleteFeatureState()

deleteFeatureState(fid)

deleteFeatureState(fid): void

Parameters
Parameter Type Description
fid number 削除する [[FeatureState]] インスタンスの ID
Returns

void

deleteFeatureState(fstate)

deleteFeatureState(fstate?): void

Parameters
Parameter Type Description
fstate? FeatureState 削除する [[FeatureState]] インスタンス
Returns

void

num_feature_states

get num_feature_states(): number

[[FeatureState]] インスタンスの数を返す。

Returns

number

num_images

get num_images(): number

インスタンスに含まれる画像の数を返す。

Returns

number

num_layers

get num_layers(): number

インスタンスに含まれるレイヤーの数を返す。

Returns

number

viewer

get viewer(): Viewer

this が設定されている [[Viewer]] インスタンスを取得する。

this がどの [[Viewer]] インスタンスにも設定されていないときは null を得る。

See

[[Viewer.setVectileManager]]

Returns

Viewer

Style Layer

getLayer()

getLayer(id): undefined | StyleLayer

レイヤー ID からレイヤーを取得する。

レイヤー ID が id と一致するレイヤーが存在すればインスタンス を返す。

そのようなレイヤーが存在しない場合は undefined を返す。

Parameters

Parameter Type Description
id string レイヤーの ID

Returns

undefined | StyleLayer

getLayerIds()

getLayerIds(): IterableIterator<string>

レイヤー ID の反復子を取得する。

Returns

IterableIterator<string>

getLayers()

getLayers(): IterableIterator<StyleLayer>

レイヤーの反復子を取得する。

Returns

IterableIterator<StyleLayer>