Class 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
- Defined in packages/mapray/src/vectile/style_manager.ts:643

ensureFeatureState

ensureFeatureState(fid): FeatureState
指定 ID の [[FeatureState]] インスタンスを確保する。

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

具体的には、インスタンスがすでに存在すれば取得して、存在しなければ生成して返す。
Parameters
- fid: number
Returns FeatureState
- Defined in packages/mapray/src/vectile/style_manager.ts:593

getFeatureState

getFeatureState(fid): undefined | FeatureState
指定 ID の [[FeatureState]] インスタンスを取得する。

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

インスタンスが存在しなければ undefined を返す。
Parameters
- fid: number
Returns undefined | FeatureState
- Defined in packages/mapray/src/vectile/style_manager.ts:617

getFeatureStates

getFeatureStates(): IterableIterator<FeatureState>
保有する [[FeatureState]] インスタンスを列挙するオブジェクトを取得する。

Returns IterableIterator<FeatureState>
- Defined in packages/mapray/src/vectile/style_manager.ts:629

Image

addImage

addImage(id, src_image, options?): void
画像を追加する。

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

追加した画像の ID は id となる。
Parameters
- id: string
  画像の ID
- src_image: ImageSource
  元画像
- Optional options: ImageOption
  追加オプション
Returns void
Throws
Error すでに id の画像が this に存在するとき。
- Defined in packages/mapray/src/vectile/style_manager.ts:719

getImageIDs

getImageIDs(): IterableIterator<string>
すべての画像の ID を取得する。

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

Returns IterableIterator<string>
画像 ID の反復可能な反復子オブジェクト
- Defined in packages/mapray/src/vectile/style_manager.ts:775

hasImage

hasImage(id): boolean
画像の有無を確認する。

ID が id である画像が this に存在するかどうかを確認する。
Parameters
- id: string
  画像の ID
Returns boolean
存在するとき true, それ以外のとき false
- Defined in packages/mapray/src/vectile/style_manager.ts:760

removeImage

removeImage(id): void
画像を削除する。

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

id の画像が this に存在しないときは何も行わない。
Parameters
- id: string
  画像の ID
Returns void
Remarks
画像を this から削除した後に、[[addImage]] により ID が id である別の画像を this に追加することができる。
- Defined in packages/mapray/src/vectile/style_manager.ts:743

Other

`Static` `Private` `Readonly` _DEFAULT_MAX_TILES_REQUESTED

_DEFAULT_MAX_TILES_REQUESTED: 50 = 50

[[_max_tiles_requested]] の既定値

`Static` `Private` _create

_create(viewer, json_style, provider_factory, cancel_helper): Promise<StyleManager>
create() の実装
Parameters
- viewer: Viewer
- json_style: OJson
- provider_factory: ProviderFactory
- cancel_helper: CancelHelper
Returns Promise<StyleManager>
- Defined in packages/mapray/src/vectile/style_manager.ts:385

`Private` `Readonly` _feature_states

_feature_states: Map<number, FeatureState>

`Private` `Readonly` _layers

_layers: Map<string, StyleLayer>

`Private` `Readonly` _max_tiles_requested

_max_tiles_requested: number

同時にリクエストできる最大の mvt タイル数

`Private` _num_tiles_requested

_num_tiles_requested: number

現在リクエスト中の mvt タイル数

`Private` `Readonly` _sources

_sources: Map<string, Source>

`Private` `Readonly` _traverser_manager

_traverser_manager: TraverserManager

`Private` _viewer

_viewer: Viewer

`Static` create

create(viewer, json_style, provider_factory): RequestResult<StyleManager>
インスタンスを生成する。

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

例外のスローは Promise の拒否を通して通知される。
Parameters
- viewer: Viewer
  設定することが可能な [[Viewer]] インスタンス
- json_style: OJson
  JSON 形式のスタイルデータ
- provider_factory: ProviderFactory
  プロバイダを生成するためのオブジェクト
Returns RequestResult<StyleManager>
リクエスト結果
Throws
Error
- あるレイヤーの source プロパティに対するソース情報が存在しなかったとき
- あるレイヤーの source プロパティに対するソース情報からプロバイダを生成することができなかった
- 何れかのソースに対するメタ情報を取得することができなかったとき
- スプライトのリソースを取得することができなかったとき
- レイヤーモジュールの初期化に失敗したとき
Throws
SyntaxError

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

See
[[Viewer.setVectileManager]]
- Defined in packages/mapray/src/vectile/style_manager.ts:365

deleteFeatureState

deleteFeatureState(fid): void
Parameters
- fid: number
  削除する [[FeatureState]] インスタンスの ID
Returns void
- Defined in packages/mapray/src/vectile/style_manager.ts:658
deleteFeatureState(fstate?): void
Parameters
- Optional fstate: FeatureState
  削除する [[FeatureState]] インスタンス
Returns void
- Defined in packages/mapray/src/vectile/style_manager.ts:664

num_feature_states

get num_feature_states(): number
[[FeatureState]] インスタンスの数を返す。

Returns number
- Defined in packages/mapray/src/vectile/style_manager.ts:539

num_images

get num_images(): number
インスタンスに含まれる画像の数を返す。

Returns number
- Defined in packages/mapray/src/vectile/style_manager.ts:701

num_layers

get num_layers(): number
インスタンスに含まれるレイヤーの数を返す。

Returns number
- Defined in packages/mapray/src/vectile/style_manager.ts:533

`Private` parseLayers

parseLayers(json_layers): void
json_layers の各レイヤーデータを解析して [[StyleLayer]] インスタンスを生成し、this._layers に追加する。
Parameters
- json_layers: Iterable<OJson>
Returns void
- Defined in packages/mapray/src/vectile/style_manager.ts:476

`Private` parseSources

parseSources(src_info_list, tile_meta_dict): void
src_info_list の各ソース情報を解析して Source インスタンスを生成し、 this._sources に追加する。

tile_meta_dict はソース名からメタ情報を取得するための辞書である。
Parameters
- src_info_list: Iterable<[string, SourceInfo]>
- tile_meta_dict: TileMetaDict
Returns void
- Defined in packages/mapray/src/vectile/style_manager.ts:459

viewer

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

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

Returns Viewer
See
[[Viewer.setVectileManager]]
- Defined in packages/mapray/src/vectile/style_manager.ts:447

Style Layer

getLayer

getLayer(id): undefined | StyleLayer
レイヤー ID からレイヤーを取得する。

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

そのようなレイヤーが存在しない場合は undefined を返す。
Parameters
- id: string
  レイヤーの ID
Returns undefined | StyleLayer
- Defined in packages/mapray/src/vectile/style_manager.ts:576

getLayerIds

getLayerIds(): IterableIterator<string>
レイヤー ID の反復子を取得する。

Returns IterableIterator<string>
- Defined in packages/mapray/src/vectile/style_manager.ts:547

getLayers

getLayers(): IterableIterator<StyleLayer>
レイヤーの反復子を取得する。

Returns IterableIterator<StyleLayer>
- Defined in packages/mapray/src/vectile/style_manager.ts:558

Class StyleManager

See

Index

Feature State

Image

Other

Style Layer

Feature State

clearFeatureStates

Returns void

ensureFeatureState

Parameters

fid: number

Returns FeatureState

getFeatureState

Parameters

fid: number

Returns undefined | FeatureState

getFeatureStates

Returns IterableIterator<FeatureState>

Image

addImage

Parameters

id: string

src_image: ImageSource

Optional options: ImageOption

Returns void

Throws

getImageIDs

Returns IterableIterator<string>

hasImage

Parameters

id: string

Returns boolean

removeImage

Parameters

id: string

Returns void

Remarks

Other

Static Private Readonly _DEFAULT_MAX_TILES_REQUESTED

Static Private _create

Parameters

viewer: Viewer

json_style: OJson

provider_factory: ProviderFactory

cancel_helper: CancelHelper

Returns Promise<StyleManager>

Private Readonly _feature_states

Private Readonly _layers

Private Readonly _max_tiles_requested

Private _num_tiles_requested

Private Readonly _sources

Private Readonly _traverser_manager

Private _viewer

Static create

Parameters

viewer: Viewer

json_style: OJson

provider_factory: ProviderFactory

Returns RequestResult<StyleManager>

Throws

Throws

See

deleteFeatureState

Parameters

fid: number

Returns void

Parameters

Optional fstate: FeatureState

Returns void

num_feature_states

Returns number

num_images

Returns number

num_layers

Returns number

Private parseLayers

Parameters

json_layers: Iterable<OJson>

`Optional` options: ImageOption

`Static` `Private` `Readonly` _DEFAULT_MAX_TILES_REQUESTED

`Static` `Private` _create

`Private` `Readonly` _feature_states

`Private` `Readonly` _layers

`Private` `Readonly` _max_tiles_requested

`Private` _num_tiles_requested

`Private` `Readonly` _sources

`Private` `Readonly` _traverser_manager

`Private` _viewer

`Static` create

`Optional` fstate: FeatureState

`Private` parseLayers

`Private` parseSources