abstract CloudApi

Mapray Cloudへアクセスするためのクラスです。

このクラスを利用するには事前にMapray Cloudアカウントを作成する必要があります。 https://cloud.mapray.com からサインアップすることができます。

事前に下記の情報を調べておきます。

• User ID:
  Mapray Cloudのユーザー情報ページから確認します。 右上メニューのAccountメニューからこのページを開くことができます。

• Token:
  Mapray CloudのTokenページでトークンを作成します。 上部のTokensタブからこのページを開くことができます。

• データセット等のID:
  Mapray Cloudへデータをアップロードし、そのデータを使用するには、データセットページ からGeoJsonやglTFデータをアップロードしておき、アップロードしたデータのIDを確認します。

MaprayCloudバージョンごとに具象クラスが定義されています。 利用するバージョンのクラスを利用します。

Version	Class
v1	mapray.cloud.CloudApiV1
v2	mapray.cloud.CloudApiV2

MaprayCloudへアクセスする関数は下記のように分類されます。

• get***AsResource():
  Maprayの各種ローダは、Resourceクラスを受け取るようになっています。[[mapray.GeoJSONLoader]]

• load***():
  適切なクラスのインスタンスを返却します。

• get***():
  最も低レベルのAPI呼び出しを行う。返却値はJSONです。

Extended by

• CloudApiV1
• CloudApiV2

Constructors

new CloudApi()

new CloudApi(version, basePath, header_key, header_value): CloudApi

Parameters

Parameter	Type	Description
version	string
basePath	undefined | string
header_key	string	header key for cloud api
header_value	string	header value for cloud api

Returns

CloudApi

Properties

basePath

readonly basePath: string

---

version

readonly version: string

Methods

count3DDatasets()

abstract count3DDatasets(): Promise<Count>

登録されている3Dデータセットの数を取得します

Returns

Promise<Count>

json

---

countB3dDatasets()

abstract countB3dDatasets(): Promise<Count>

登録されているB3Dデータセットの数を取得します

Returns

Promise<Count>

json

---

countDatasets()

abstract countDatasets(): Promise<Count>

登録されているデータセットの数を取得します

Returns

Promise<Count>

json

---

countDemDatasets()

abstract countDemDatasets(): Promise<Count>

登録されているDemデータセットの数を取得します

Returns

Promise<Count>

json

---

countPointCloudDatasets()

abstract countPointCloudDatasets(): Promise<Count>

登録されている点群データセットの数を取得します

Returns

Promise<Count>

json

---

countTilesetDatasets()

abstract countTilesetDatasets(): Promise<Count>

登録されているTilesetデータセットの数を取得します

Returns

Promise<Count>

json

---

delete()

protected delete<T>(api, args, query?, option?): Promise<T>

低レベルAPI。このクラスの別関数から呼び出される。

Type parameters

Type parameter
T

Parameters

Parameter	Type
api	string
args	string[]
query?	Query
option?	object

Returns

Promise<T>

json

---

fetch()

protected fetch(method, url, query?, body?, option?): Promise<Response>

低レベルAPI。このクラスの別関数から呼び出される。

Parameters

Parameter	Type
method	string
url	string
query?	Query
body?	Body
option?	RequestInit

Returns

Promise<Response>

json

---

fetchAPI()

protected fetchAPI<T>(method, api, args, query?, body?, option?): Promise<T>

低レベルAPI。このクラスの別関数から呼び出される。

Type parameters

Type parameter
T

Parameters

Parameter	Type
method	string
api	string
args	string[]
query?	Query
body?	Body
option?	object

Returns

Promise<T>

json

---

get()

protected get<T>(api, args, query?, option?): Promise<T>

低レベルAPI。このクラスの別関数から呼び出される。

Type parameters

Type parameter
T

Parameters

Parameter	Type
api	string
args	string[]
query?	Query
option?	object

Returns

Promise<T>

json

---

get3DDatasetAsResource()

get3DDatasetAsResource(datasetId)

get3DDatasetAsResource(datasetId): Dataset3DResource

指定したIDの3Dデータセットをリソースとして取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

Dataset3DResource

3Dデータセットのリソース

get3DDatasetAsResource(datasetIds)

get3DDatasetAsResource(datasetIds): Dataset3DResource

指定したIDの3Dデータセットをリソースとして取得します。

Parameters

Parameter	Type
datasetIds	string[]

Returns

Dataset3DResource

3Dデータセットのリソース

Deprecated

---

get3DDatasetScene()

abstract get3DDatasetScene(datasetIds): Promise<SceneJson>

3Dデータセットに含まれる scene情報 を取得します。

Parameters

Parameter	Type	Description
datasetIds	string | string[]

Returns

Promise<SceneJson>

シーンファイルの実体

---

get3DDatasets()

abstract get3DDatasets(page, limit): Promise<Json[]>

3Dデータセットのリストを取得します。

Parameters

Parameter	Type	Description
page	number	取得する要素のページ番号
limit	number	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Json[]>

json

---

getB3dDataset()

abstract getB3dDataset(datasetId): Promise<Json>

B3Dデータセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットId

Returns

Promise<Json>

json

---

getB3dDatasetAsResource()

getB3dDatasetAsResource(datasetId): B3dDatasetResource

指定したIDのB3Dデータセットの定義ファイルをリソースとして取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

B3dDatasetResource

B3Dデータのリソース

---

getB3dDatasets()

abstract getB3dDatasets(page, limit): Promise<Json[]>

B3Dデータセットリストを取得します。

Parameters

Parameter	Type	Description
page	number	取得する要素のページ番号
limit	number	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Json[]>

json

---

getDataset()

abstract getDataset(datasetId): Promise<Json>

get dataset

Parameters

Parameter	Type	Description
datasetId	string

Returns

Promise<Json>

json

---

getDatasetAsResource()

getDatasetAsResource(datasetId): DatasetResource

指定したIDのデータセットをリソースとして取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

DatasetResource

データセットのリソース

---

getDatasetFeaturesAsResource()

getDatasetFeaturesAsResource(datasetId): DatasetFeaturesResource

指定したIDのデータセットを Feature リソースとして取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

DatasetFeaturesResource

データセットの Feature リソース

---

getDatasets()

abstract getDatasets(page, limit): Promise<Json[]>

データセットリストを取得します

Parameters

Parameter	Type	Description
page	number	取得する要素のページ番号
limit	number	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Json[]>

json[]

---

getDefaultDemAsResource()

getDefaultDemAsResource(): Resource

デフォルトのDemデータをリソースとして取得します。

Returns

Resource

デフォルトDemデータのリソース

---

getDemDataset()

abstract getDemDataset(datasetId): Promise<Json>

Demデータセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットId

Returns

Promise<Json>

json

---

getDemDatasetAsResource()

getDemDatasetAsResource(datasetId): DemDatasetResource

指定したIDのDemデータセットの定義ファイルをリソースとして取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

DemDatasetResource

Demデータのリソース

---

getDemDatasets()

abstract getDemDatasets(page, limit): Promise<Json[]>

Demデータセットリストを取得します。

Parameters

Parameter	Type	Description
page	number	取得する要素のページ番号
limit	number	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Json[]>

json

---

getFeatures()

abstract getFeatures(datasetId): Promise<FeatureCollectionJson>

GeoJSONの内容を取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

Promise<FeatureCollectionJson>

json

---

getPointCloudDataset()

abstract getPointCloudDataset(datasetId): Promise<Json>

点群データセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットId

Returns

Promise<Json>

json

---

getPointCloudDatasetAsResource()

getPointCloudDatasetAsResource(datasetId): PointCloudDatasetResource

指定したIDの点群データセットの定義ファイルをリソースとして取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

PointCloudDatasetResource

点群データのリソース

---

getPointCloudDatasets()

abstract getPointCloudDatasets(page, limit): Promise<Json[]>

点群データセットリストを取得します。

Parameters

Parameter	Type	Description
page	number	取得する要素のページ番号
limit	number	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Json[]>

json

---

getScene()

abstract getScene(sceneId): Promise<Json>

シーンを取得します。

CloudApiV2でのみ対応しています。

Parameters

Parameter	Type	Description
sceneId	string	シーンId

Returns

Promise<Json>

json

---

getSceneAsResource()

getSceneAsResource(sceneId): SceneResource

指定したIDのシーンのシーンファイルをリソースとして取得します。

CloudApiV2でのみ対応しています。

Parameters

Parameter	Type	Description
sceneId	string	シーンID

Returns

SceneResource

シーンのリソース

---

getSceneContent()

abstract getSceneContent(sceneId): Promise<SceneJson>

シーンファイルを取得します。

CloudApiV2でのみ対応しています。

Parameters

Parameter	Type	Description
sceneId	string	シーンId

Returns

Promise<SceneJson>

json

---

getScenes()

abstract getScenes(page, limit): Promise<Json[]>

シーンリストを取得します。

CloudApiV2でのみ対応しています。

Parameters

Parameter	Type	Description
page	number	取得する要素のページ番号
limit	number	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Json[]>

json

---

getTilesetDataset()

abstract getTilesetDataset(datasetId): Promise<Json>

Tilesetデータセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットId

Returns

Promise<Json>

json

---

getTilesetDatasetAsResource()

getTilesetDatasetAsResource(datasetId): TilesetDatasetResource

指定したIDのTilesetデータセットの定義ファイルをリソースとして取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

TilesetDatasetResource

Tilesetデータのリソース

---

getTilesetDatasets()

abstract getTilesetDatasets(page, limit): Promise<Json[]>

Tilesetデータセットリストを取得します。

Parameters

Parameter	Type	Description
page	number	取得する要素のページ番号
limit	number	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Json[]>

json

---

getVectile()

abstract getVectile(datasetId): Promise<Json>

Vectileデータセットを取得します。

CloudApiV2でのみ対応しています。

Parameters

Parameter	Type	Description
datasetId	string	データセットId

Returns

Promise<Json>

json

---

getVectileDatasetAsResource()

getVectileDatasetAsResource(datasetId): VectileDatasetResource

指定したIDのVectileデータセットをリソースとして取得します。

CloudApiV2でのみ対応しています。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

VectileDatasetResource

Vectileデータセットのリソース

---

load3DDataset()

load3DDataset(datasetId): Promise<Dataset3D>

指定したIDの3Dデータセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string

Returns

Promise<Dataset3D>

3Dデータセット

---

load3DDatasets()

load3DDatasets(page, limit): Promise<Dataset3D[]>

3Dデータセットのリストを取得します。 ページごとにデータセットリストを取得します。

Parameters

Parameter	Type	Default value	Description
page	number	1	取得する要素のページ番号
limit	number	5	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Dataset3D[]>

3Dデータセットの配列

---

loadB3dDataset()

loadB3dDataset(datasetId): Promise<B3dDataset>

指定したIDのB3Dデータセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

Promise<B3dDataset>

B3Dデータセット

---

loadB3dDatasets()

loadB3dDatasets(page, limit): Promise<B3dDataset[]>

B3Dデータセットのリストを取得します。 ページごとにデータセットリストを取得します。

Parameters

Parameter	Type	Default value	Description
page	number	1	取得する要素のページ番号
limit	number	5	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<B3dDataset[]>

B3Dデータセットの配列

---

loadDataset()

loadDataset(datasetId): Promise<Dataset>

指定したIDのデータセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットのID

Returns

Promise<Dataset>

データセット

---

loadDatasets()

loadDatasets(page, limit): Promise<Dataset[]>

データセットのリストを取得します。 ページごとにデータセットリストを取得します。

Parameters

Parameter	Type	Default value	Description
page	number	1	取得する要素のページ番号
limit	number	5	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Dataset[]>

データセットの配列

---

loadDemDataset()

loadDemDataset(datasetId): Promise<DemDataset>

指定したIDのDemデータセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

Promise<DemDataset>

Demデータセット

---

loadDemDatasets()

loadDemDatasets(page, limit): Promise<DemDataset[]>

Demデータセットのリストを取得します。 ページごとにデータセットリストを取得します。

Parameters

Parameter	Type	Default value	Description
page	number	1	取得する要素のページ番号
limit	number	5	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<DemDataset[]>

Demデータセットの配列

---

loadPointCloudDataset()

loadPointCloudDataset(datasetId): Promise<PointCloudDataset>

指定したIDの点群データセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

Promise<PointCloudDataset>

点群データセット

---

loadPointCloudDatasets()

loadPointCloudDatasets(page, limit): Promise<PointCloudDataset[]>

点群データセットのリストを取得します。 ページごとにデータセットリストを取得します。

Parameters

Parameter	Type	Default value	Description
page	number	1	取得する要素のページ番号
limit	number	5	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<PointCloudDataset[]>

点群データセットの配列

---

loadScene()

loadScene(sceneId): Promise<Scene>

指定したIDのシーンを取得します。

CloudApiV2でのみ対応しています。

Parameters

Parameter	Type	Description
sceneId	string	シーンのID

Returns

Promise<Scene>

シーン

---

loadScenes()

loadScenes(page, limit): Promise<Scene[]>

シーンのリストを取得します。 ページごとにシーンリストを取得します。

CloudApiV2でのみ対応しています。

Parameters

Parameter	Type	Default value	Description
page	number	1	取得する要素のページ番号
limit	number	5	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<Scene[]>

シーンの配列

---

loadTilesetDataset()

loadTilesetDataset(datasetId): Promise<TilesetDataset>

指定したIDのTilesetデータセットを取得します。

Parameters

Parameter	Type	Description
datasetId	string	データセットID

Returns

Promise<TilesetDataset>

Tilesetデータセット

---

loadTilesetDatasets()

loadTilesetDatasets(page, limit): Promise<TilesetDataset[]>

Tilesetデータセットのリストを取得します。 ページごとにデータセットリストを取得します。

Parameters

Parameter	Type	Default value	Description
page	number	1	取得する要素のページ番号
limit	number	5	1ページに含まれる要素数。最大100まで指定することができます。

Returns

Promise<TilesetDataset[]>

Tilesetデータセットの配列

---

patch()

protected patch<T>(api, args, query?, body?, option?): Promise<T>

低レベルAPI。このクラスの別関数から呼び出される。

Type parameters

Type parameter
T

Parameters

Parameter	Type
api	string
args	string[]
query?	Query
body?	Body
option?	object

Returns

Promise<T>

json

---

post()

protected post<T>(api, args, query?, body?, option?): Promise<T>

低レベルAPI。このクラスの別関数から呼び出される。

Type parameters

Type parameter
T

Parameters

Parameter	Type
api	string
args	string[]
query?	Query
body?	Body
option?	object

Returns

Promise<T>

json

---

put()

protected put<T>(api, args, query?, body?, option?): Promise<T>

低レベルAPI。このクラスの別関数から呼び出される。

Type parameters

Type parameter
T

Parameters

Parameter	Type
api	string
args	string[]
query?	Query
body?	Body
option?	object

Returns

Promise<T>

json