コンテンツにスキップ

SimpleProviderFactory

機能が単純な [[ProviderFactory]] の実装クラスである。

タイル用のプロバイダに関しては次の制限がある。

  • 生成されるすべての [[TileProvider]] インスタンスは、 [[StandardTileProvider]] インスタンスに限定される。
  • スタイルにソースが複数存在する場合でも、[[StandardTileProvider]] インスタンスの生成には同じオプションしか使用されない。
  • [[StandardTileProvider]] インスタンスが生成されるソースは、スタイルの url プロパティの値が http:// または https:// で始まり / で終わ るものに限られる。
  • この url プロパティの値が [[StandardTileProvider.constructor]] の prefix パラメータとして使用される。

スプライト用のプロバイダに関しては次の制限がある。

  • 生成されるすべての [[SpriteProvider]] インスタンスは、 [[StandardSpriteProvider]] インスタンスに限定される。
  • [[StandardSpriteProvider]] インスタンスが生成されるスプライトは、スタイルの sprite プロパティの値が http:// または https:// で始まるものに限られる。
  • この sprite プロパティの値が [[StandardSpriteProvider.constructor]] の prefix パラメータとして使用される。
  • ただし sprite プロパティが存在しない場合、スプライト用のプロバイダ は生成しない。

Extends

Constructors

new SimpleProviderFactory()

new SimpleProviderFactory(options?): SimpleProviderFactory

初期化

Parameters

Parameter Type Description
options? Option プロバイダのインスタンス生成に使用されるオプション

Returns

SimpleProviderFactory

Overrides

ProviderFactory.constructor

Remarks

this が使用されている間に options の内容を変更したときの動作は 未定義である。

Methods

createSpriteProvider()

createSpriteProvider(location?): null | SpriteProvider

スプライト指定に対応するプロバイダを生成する。

location パラメータにはスタイルの sprite プロパティに記述された文字列が設定されて呼び出される。

ただし、スタイルに sprite プロパティが存在しない場合、location パラメータが省略されて呼び出される。

実装は location を参照し、適切な [[SpriteProvider]] インスタンスを 返さなければならない。ただしそのようなプロバイダを判断できない、または 生成できないときは null を返してもよい。

Parameters

Parameter Type Description
location? string スタイルに記述されたスプライト指定

Returns

null | SpriteProvider

Overrides

ProviderFactory.createSpriteProvider


createTileProvider()

createTileProvider(_source_id, json_source): null | TileProvider

ベクトルタイルのデータソース情報に対応するプロバイダを生成する。

source_id パラメータは sources オブジェクトのプロパティ名に対応する。

json_source パラメータは vector オブジェクトの形式に従っている。

json_source.type の値は常に "vector" であるが、その他のプロ パティはオプションである。

実装はこれらのパラメータの情報を参照し、適切な [[TileProvider]] インスタンスを返さなければならない。ただしそのようなプロバイダ を判断できない、または生成できないときは null を返してもよい。

Parameters

Parameter Type Description
_source_id string スタイルに記述されたソース ID
json_source OJson スタイルに記述されたソース情報

Returns

null | TileProvider

Overrides

ProviderFactory.createTileProvider