Class StandardSpriteProvider

スプライトデータのための汎用的なプロバイダ実装である。

requestLayout() は次の URL のオブジェクトを要求する。

prefix + options.layout_suffix

requestSheet() は次の URL のオブジェクトを要求する。

prefix + options.sheet_suffix

prefix は一般的に "http://" または "https://" で始まる文字列を指定する。

See

constructor, Option

Hierarchy

SpriteProvider
- StandardSpriteProvider

Index

Constructors

constructor

new StandardSpriteProvider(prefix: string, options?: mapray.vectile.StandardSpriteProvider.Option): StandardSpriteProvider
Parameters
- prefix: string
  
  URL の先頭文字列
- Optional options: mapray.vectile.StandardSpriteProvider.Option
  
  オプション辞書
Returns StandardSpriteProvider
Overrides SpriteProvider.constructor
- Defined in packages/mapray/src/vectile/StandardSpriteProvider.ts:31

Properties

`Private` `Readonly` _layout_credentials

_layout_credentials: RequestCredentials

`Private` `Readonly` _layout_headers

_layout_headers: mapray.vectile.StandardSpriteProvider.Headers

`Private` `Readonly` _layout_suffix

_layout_suffix: string

`Private` `Readonly` _prefix

_prefix: string

`Private` `Readonly` _sheet_credentials

_sheet_credentials: RequestCredentials

`Private` `Readonly` _sheet_headers

_sheet_headers: mapray.vectile.StandardSpriteProvider.Headers

`Private` `Readonly` _sheet_suffix

_sheet_suffix: string

Methods

`Private` _getLayout

_getLayout(asignal: AbortSignal): Promise<mapray.vectile.SpriteProvider.Layout>
LayoutItem のリストを取得 (Promise)
Parameters
- asignal: AbortSignal
Returns Promise<mapray.vectile.SpriteProvider.Layout>
- Defined in packages/mapray/src/vectile/StandardSpriteProvider.ts:93

`Private` _getLayoutAsJson

_getLayoutAsJson(asignal: AbortSignal): Promise<mapray.Json>
レイアウトデータが記述された Json インスタンスを取得 (Promise)
Parameters
- asignal: AbortSignal
Returns Promise<mapray.Json>
- Defined in packages/mapray/src/vectile/StandardSpriteProvider.ts:103

`Private` _getSheet

_getSheet(asignal: AbortSignal): Promise<HTMLImageElement>
スプライト画像を取得 (Promise)
Parameters
- asignal: AbortSignal
Returns Promise<HTMLImageElement>
- Defined in packages/mapray/src/vectile/StandardSpriteProvider.ts:125

`Private` _make_layout_data_url

_make_layout_data_url(): string
レイアウトデータの URL を作成

Returns string
- Defined in packages/mapray/src/vectile/StandardSpriteProvider.ts:75

`Private` _make_sheet_data_url

_make_sheet_data_url(): string
スプライト画像データの URL を作成

Returns string
- Defined in packages/mapray/src/vectile/StandardSpriteProvider.ts:84

requestLayout

requestLayout(): RequestResult<mapray.vectile.SpriteProvider.Layout>
スプライトのレイアウト情報を要求する。

Returns RequestResult<mapray.vectile.SpriteProvider.Layout>
Overrides SpriteProvider.requestLayout
- Defined in packages/mapray/src/vectile/StandardSpriteProvider.ts:49

requestSheet

requestSheet(): RequestResult<TexImageSource>
スプライトの画像データを要求する。

Returns RequestResult<TexImageSource>
Overrides SpriteProvider.requestSheet
- Defined in packages/mapray/src/vectile/StandardSpriteProvider.ts:61

`Static` parseLayoutData

parseLayoutData(json_layout: mapray.Json): mapray.vectile.SpriteProvider.Layout
index-file 形式のレイアウトデータを解析して Layout に変換する。

Throws
SyntaxError json_layout が予期しないデータ形式のとき
Parameters
- json_layout: mapray.Json
  
  レイアウトデータ
Returns mapray.vectile.SpriteProvider.Layout
Inherited from SpriteProvider.parseLayoutData
- Defined in packages/mapray/src/vectile/SpriteProvider.ts:48

Class StandardSpriteProvider

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

prefix: string

Optional options: mapray.vectile.StandardSpriteProvider.Option

Returns StandardSpriteProvider

Properties

Private Readonly _layout_credentials

Private Readonly _layout_headers

Private Readonly _layout_suffix

Private Readonly _prefix

Private Readonly _sheet_credentials

Private Readonly _sheet_headers

Private Readonly _sheet_suffix

Methods

Private _getLayout

Parameters

asignal: AbortSignal

Returns Promise<mapray.vectile.SpriteProvider.Layout>

Private _getLayoutAsJson

Parameters

asignal: AbortSignal

Returns Promise<mapray.Json>

Private _getSheet

Parameters

asignal: AbortSignal

Returns Promise<HTMLImageElement>

Private _make_layout_data_url

Returns string

Private _make_sheet_data_url

Returns string

requestLayout

Returns RequestResult<mapray.vectile.SpriteProvider.Layout>

requestSheet

Returns RequestResult<TexImageSource>

Static parseLayoutData

Throws

Parameters

json_layout: mapray.Json

Returns mapray.vectile.SpriteProvider.Layout

Settings

Member Visibility

Theme

`Optional` options: mapray.vectile.StandardSpriteProvider.Option

`Private` `Readonly` _layout_credentials

`Private` `Readonly` _layout_headers

`Private` `Readonly` _layout_suffix

`Private` `Readonly` _prefix

`Private` `Readonly` _sheet_credentials

`Private` `Readonly` _sheet_headers

`Private` `Readonly` _sheet_suffix

`Private` _getLayout

`Private` _getLayoutAsJson

`Private` _getSheet

`Private` _make_layout_data_url

`Private` _make_sheet_data_url

`Static` parseLayoutData