Class CloudApi`Abstract`

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です。

Hierarchy (view full)

CloudApi
- CloudApiV1
- CloudApiV2

Constructors

constructor

new CloudApi(version, basePath, header_key, header_value): CloudApi
Parameters
- version: string
- basePath: undefined | string
- header_key: string
  header key for cloud api
- header_value: string
  header value for cloud api
Returns CloudApi
- Defined in packages/mapray/src/cloud/CloudApi.ts:64

Properties

`Private` _header_key

_header_key: string

`Private` _header_value

_header_value: string

`Readonly` basePath

basePath: string

`Readonly` version

version: string

Methods

`Abstract` count3DDatasets

count3DDatasets(): Promise<mapray.cloud.Dataset3D.Count>
登録されている3Dデータセットの数を取得します

Returns Promise<mapray.cloud.Dataset3D.Count>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:307

`Abstract` countDatasets

countDatasets(): Promise<mapray.cloud.Dataset.Count>
登録されているデータセットの数を取得します

Returns Promise<mapray.cloud.Dataset.Count>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:238

`Abstract` countPointCloudDatasets

countPointCloudDatasets(): Promise<mapray.cloud.PointCloudDataset.Count>
登録されている点群データセットの数を取得します

Returns Promise<mapray.cloud.PointCloudDataset.Count>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:389

`Protected` delete

delete<T>(api, args, query?, option?): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- option: {} = {}
Returns Promise<T>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:475

`Protected` fetch

fetch(method, url, query?, body?, option?): Promise<Response>
低レベルAPI。このクラスの別関数から呼び出される。
Parameters
- method: string
- url: string
- Optional query: Query
- Optional body: Body
- option: RequestInit = {}
Returns Promise<Response>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:497

`Protected` fetchAPI

fetchAPI<T>(method, api, args, query?, body?, option?): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。
Type Parameters
- T
Parameters
- method: string
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:484

`Protected` get

get<T>(api, args, query?, option?): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- option: {} = {}
Returns Promise<T>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:430

get3DDatasetAsResource

get3DDatasetAsResource(datasetIds): Resource
指定したIDの3Dデータセットのシーンファイルをリソースとして取得します。
Parameters
- datasetIds: string[]
Returns Resource
3Dデータセットのリソース
- Defined in packages/mapray/src/cloud/CloudApi.ts:196

`Abstract` get3DDatasetScene

get3DDatasetScene(datasetIds): Promise<SceneJson>
3Dデータセットに含まれる scene情報を取得します。
Parameters
- datasetIds: string | string[]
Returns Promise<SceneJson>
シーンファイルの実体
- Defined in packages/mapray/src/cloud/CloudApi.ts:375

`Abstract` get3DDatasets

get3DDatasets(page, limit): Promise<mapray.cloud.Dataset3D.Json[]>
3Dデータセットのリストを取得します。
Parameters
- page: number
  取得する要素のページ番号
- limit: number
  1ページに含まれる要素数。最大100まで指定することができます。
Returns Promise<mapray.cloud.Dataset3D.Json[]>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:301

`Abstract` getDataset

getDataset(datasetId): Promise<mapray.cloud.Dataset.Json>
get dataset
Parameters
- datasetId: string
Returns Promise<mapray.cloud.Dataset.Json>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:245

getDatasetAsResource

getDatasetAsResource(datasetId): Resource
指定したIDのデータセットをリソースとして取得します。
Parameters
- datasetId: string
  データセットID
Returns Resource
データセットのリソース
- Defined in packages/mapray/src/cloud/CloudApi.ts:186

`Abstract` getDatasets

getDatasets(page, limit): Promise<mapray.cloud.Dataset.Json[]>
データセットリストを取得します
Parameters
- page: number
  取得する要素のページ番号
- limit: number
  1ページに含まれる要素数。最大100まで指定することができます。
Returns Promise<mapray.cloud.Dataset.Json[]>
json[]
- Defined in packages/mapray/src/cloud/CloudApi.ts:232

`Abstract` getFeatures

getFeatures(datasetId): Promise<FeatureCollectionJson>
GeoJSONの内容を取得します。
Parameters
- datasetId: string
  データセットID
Returns Promise<FeatureCollectionJson>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:267

`Abstract` getPointCloudDataset

getPointCloudDataset(datasetId): Promise<mapray.cloud.PointCloudDataset.Json>
点群データセットを取得します。
Parameters
- datasetId: string
  データセットId
Returns Promise<mapray.cloud.PointCloudDataset.Json>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:396

getPointCloudDatasetAsResource

getPointCloudDatasetAsResource(datasetId): Resource
指定したIDの点群データセットの定義ファイルをリソースとして取得します。
Parameters
- datasetId: string
  データセットID
Returns Resource
点群データのリソース
- Defined in packages/mapray/src/cloud/CloudApi.ts:206

`Abstract` getPointCloudDatasets

getPointCloudDatasets(page, limit): Promise<mapray.cloud.PointCloudDataset.Json[]>
点群データセットリストを取得します。
Parameters
- page: number
  取得する要素のページ番号
- limit: number
  1ページに含まれる要素数。最大100まで指定することができます。
Returns Promise<mapray.cloud.PointCloudDataset.Json[]>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:383

`Abstract` getScene

getScene(sceneId): Promise<mapray.cloud.Scene.Json>
シーンを取得します。

*CloudApiV2でのみ対応しています。
Parameters
- sceneId: string
  シーンId
Returns Promise<mapray.cloud.Scene.Json>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:415

getSceneAsResource

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

*CloudApiV2でのみ対応しています。
Parameters
- sceneId: string
  シーンID
Returns Resource
シーンのリソース
- Defined in packages/mapray/src/cloud/CloudApi.ts:218

`Abstract` getSceneContent

getSceneContent(sceneId): Promise<SceneJson>
シーンファイルを取得します。

*CloudApiV2でのみ対応しています。
Parameters
- sceneId: string
  シーンId
Returns Promise<SceneJson>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:424

`Abstract` getScenes

getScenes(page, limit): Promise<mapray.cloud.Scene.Json[]>
シーンリストを取得します。

*CloudApiV2でのみ対応しています。
Parameters
- page: number
  取得する要素のページ番号
- limit: number
  1ページに含まれる要素数。最大100まで指定することができます。
Returns Promise<mapray.cloud.Scene.Json[]>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:406

load3DDataset

load3DDataset(datasetId): Promise<Dataset3D>
指定したIDの3Dデータセットを取得します。
Parameters
- datasetId: string
Returns Promise<Dataset3D>
3Dデータセット
- Defined in packages/mapray/src/cloud/CloudApi.ts:120

load3DDatasets

load3DDatasets(page?, limit?): Promise<Dataset3D[]>
3Dデータセットのリストを取得します。ページごとにデータセットリストを取得します。
Parameters
- page: number = 1
  取得する要素のページ番号
- limit: number = 5
  1ページに含まれる要素数。最大100まで指定することができます。
Returns Promise<Dataset3D[]>
3Dデータセットの配列
- Defined in packages/mapray/src/cloud/CloudApi.ts:109

loadDataset

loadDataset(datasetId): Promise<Dataset>
指定したIDのデータセットを取得します。
Parameters
- datasetId: string
  データセットのID
Returns Promise<Dataset>
データセット
- Defined in packages/mapray/src/cloud/CloudApi.ts:96

loadDatasets

loadDatasets(page?, limit?): Promise<Dataset[]>
データセットのリストを取得します。ページごとにデータセットリストを取得します。
Parameters
- page: number = 1
  取得する要素のページ番号
- limit: number = 5
  1ページに含まれる要素数。最大100まで指定することができます。
Returns Promise<Dataset[]>
データセットの配列
- Defined in packages/mapray/src/cloud/CloudApi.ts:85

loadPointCloudDataset

loadPointCloudDataset(datasetId): Promise<PointCloudDataset>
指定したIDの点群データセットを取得します。
Parameters
- datasetId: string
  データセットID
Returns Promise<PointCloudDataset>
点群データセット
- Defined in packages/mapray/src/cloud/CloudApi.ts:144

loadPointCloudDatasets

loadPointCloudDatasets(page?, limit?): Promise<PointCloudDataset[]>
点群データセットのリストを取得します。ページごとにデータセットリストを取得します。
Parameters
- page: number = 1
  取得する要素のページ番号
- limit: number = 5
  1ページに含まれる要素数。最大100まで指定することができます。
Returns Promise<PointCloudDataset[]>
点群データセットの配列
- Defined in packages/mapray/src/cloud/CloudApi.ts:133

loadScene

loadScene(sceneId): Promise<mapray.cloud.Scene>
指定したIDのシーンを取得します。

*CloudApiV2でのみ対応しています。
Parameters
- sceneId: string
  シーンのID
Returns Promise<mapray.cloud.Scene>
シーン
- Defined in packages/mapray/src/cloud/CloudApi.ts:172

loadScenes

loadScenes(page?, limit?): Promise<mapray.cloud.Scene[]>
シーンのリストを取得します。ページごとにシーンリストを取得します。

*CloudApiV2でのみ対応しています。
Parameters
- page: number = 1
  取得する要素のページ番号
- limit: number = 5
  1ページに含まれる要素数。最大100まで指定することができます。
Returns Promise<mapray.cloud.Scene[]>
シーンの配列
- Defined in packages/mapray/src/cloud/CloudApi.ts:159

`Protected` patch

patch<T>(api, args, query?, body?, option?): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:451

`Protected` post

post<T>(api, args, query?, body?, option?): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:439

`Protected` put

put<T>(api, args, query?, body?, option?): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
json
- Defined in packages/mapray/src/cloud/CloudApi.ts:463

Class CloudApiAbstract

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

version: string

basePath: undefined | string

header_key: string

header_value: string

Returns CloudApi

Properties

Private _header_key

Private _header_value

Readonly basePath

Readonly version

Methods

Abstract count3DDatasets

Returns Promise<mapray.cloud.Dataset3D.Count>

Abstract countDatasets

Returns Promise<mapray.cloud.Dataset.Count>

Abstract countPointCloudDatasets

Returns Promise<mapray.cloud.PointCloudDataset.Count>

Protected delete

Type Parameters

T

Parameters

api: string

args: string[]

Optional query: Query

option: {} = {}

Returns Promise<T>

Protected fetch

Parameters

method: string

url: string

Optional query: Query

Optional body: Body

option: RequestInit = {}

Returns Promise<Response>

Protected fetchAPI

Type Parameters

T

Parameters

method: string

api: string

args: string[]

Optional query: Query

Optional body: Body

option: {} = {}

Returns Promise<T>

Protected get

Type Parameters

T

Parameters

api: string

args: string[]

Optional query: Query

option: {} = {}

Returns Promise<T>

get3DDatasetAsResource

Parameters

datasetIds: string[]

Returns Resource

Abstract get3DDatasetScene

Parameters

datasetIds: string | string[]

Returns Promise<SceneJson>

Abstract get3DDatasets

Parameters

page: number

limit: number

Returns Promise<mapray.cloud.Dataset3D.Json[]>

Abstract getDataset

Parameters

datasetId: string

Returns Promise<mapray.cloud.Dataset.Json>

Class CloudApi`Abstract`

`Private` _header_key

`Private` _header_value

`Readonly` basePath

`Readonly` version

`Abstract` count3DDatasets

`Abstract` countDatasets

`Abstract` countPointCloudDatasets

`Protected` delete

`Optional` query: Query

`Protected` fetch

`Optional` query: Query

`Optional` body: Body

`Protected` fetchAPI

`Optional` query: Query

`Optional` body: Body

`Protected` get

`Optional` query: Query

`Abstract` get3DDatasetScene

`Abstract` get3DDatasets

`Abstract` getDataset

`Abstract` getDatasets

`Abstract` getFeatures

`Abstract` getPointCloudDataset

`Abstract` getPointCloudDatasets

`Abstract` getScene

`Abstract` getSceneContent

`Abstract` getScenes