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

CloudApi
- CloudApiV1
- CloudApiV2

Constructors

constructor

new CloudApi(version: string, basePath: undefined | string, header_key: string, header_value: string): 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
json

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

`Abstract` countDatasets

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

Returns
json

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

`Abstract` countPointCloudDatasets

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

Returns
json

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

`Protected` delete

delete<T>(api: string, args: string[], query?: Query, option?: {}): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。

Returns
json
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- option: {} = {}
Returns Promise<T>
- Defined in packages/mapray/src/cloud/CloudApi.ts:459

`Protected` fetch

fetch(method: string, url: string, query?: Query, body?: Body, option?: RequestInit): Promise<Response>
低レベルAPI。このクラスの別関数から呼び出される。

Returns
json
Parameters
- method: string
- url: string
- Optional query: Query
- Optional body: Body
- option: RequestInit = {}
Returns Promise<Response>
- Defined in packages/mapray/src/cloud/CloudApi.ts:481

`Protected` fetchAPI

fetchAPI<T>(method: string, api: string, args: string[], query?: Query, body?: Body, option?: {}): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。

Returns
json
Type Parameters
- T
Parameters
- method: string
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
- Defined in packages/mapray/src/cloud/CloudApi.ts:468

`Protected` get

get<T>(api: string, args: string[], query?: Query, option?: {}): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。

Returns
json
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- option: {} = {}
Returns Promise<T>
- Defined in packages/mapray/src/cloud/CloudApi.ts:414

get3DDatasetAsResource

get3DDatasetAsResource(datasetIds: string[]): Resource
指定したIDの3Dデータセットのシーンファイルをリソースとして取得します。

Returns
3Dデータセットのリソース
Parameters
- datasetIds: string[]
Returns Resource
- Defined in packages/mapray/src/cloud/CloudApi.ts:196

`Abstract` get3DDatasetScene

get3DDatasetScene(datasetIds: string | string[]): Promise<SceneJson>
3Dデータセットに含まれる scene情報を取得します。

Returns
シーンファイルの実体
Parameters
- datasetIds: string | string[]
Returns Promise<SceneJson>
- Defined in packages/mapray/src/cloud/CloudApi.ts:359

`Abstract` get3DDatasets

get3DDatasets(page: number, limit: number): Promise<mapray.cloud.Dataset3D.Json[]>
3Dデータセットのリストを取得します。

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

`Abstract` getDataset

getDataset(datasetId: string): Promise<mapray.cloud.Dataset.Json>
get dataset

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

getDatasetAsResource

getDatasetAsResource(datasetId: string): Resource
指定したIDのデータセットをリソースとして取得します。

Returns
データセットのリソース
Parameters
- datasetId: string
  
  データセットID
Returns Resource
- Defined in packages/mapray/src/cloud/CloudApi.ts:186

`Abstract` getDatasets

getDatasets(page: number, limit: number): Promise<mapray.cloud.Dataset.Json[]>
データセットリストを取得します

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

`Abstract` getFeatures

getFeatures(datasetId: string): Promise<FeatureCollectionJson>
GeoJSONの内容を取得します。

Returns
json
Parameters
- datasetId: string
  
  データセットID
Returns Promise<FeatureCollectionJson>
- Defined in packages/mapray/src/cloud/CloudApi.ts:267

`Abstract` getPointCloudDataset

getPointCloudDataset(datasetId: string): Promise<mapray.cloud.PointCloudDataset.Json>
点群データセットを取得します。

Returns
json
Parameters
- datasetId: string
  
  データセットId
Returns Promise<mapray.cloud.PointCloudDataset.Json>
- Defined in packages/mapray/src/cloud/CloudApi.ts:380

getPointCloudDatasetAsResource

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

Returns
点群データのリソース
Parameters
- datasetId: string
  
  データセットID
Returns Resource
- Defined in packages/mapray/src/cloud/CloudApi.ts:206

`Abstract` getPointCloudDatasets

getPointCloudDatasets(page: number, limit: number): Promise<mapray.cloud.PointCloudDataset.Json[]>
点群データセットリストを取得します。

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

`Abstract` getScene

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

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

Returns
json
Parameters
- sceneId: string
  
  シーンId
Returns Promise<mapray.cloud.Scene.Json>
- Defined in packages/mapray/src/cloud/CloudApi.ts:399

getSceneAsResource

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

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

Returns
シーンのリソース
Parameters
- sceneId: string
  
  シーンID
Returns Resource
- Defined in packages/mapray/src/cloud/CloudApi.ts:218

`Abstract` getSceneContent

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

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

Returns
json
Parameters
- sceneId: string
  
  シーンId
Returns Promise<SceneJson>
- Defined in packages/mapray/src/cloud/CloudApi.ts:408

`Abstract` getScenes

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

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

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

load3DDataset

load3DDataset(datasetId: string): Promise<Dataset3D>
指定したIDの3Dデータセットを取得します。

Returns
3Dデータセット
Parameters
- datasetId: string
Returns Promise<Dataset3D>
- Defined in packages/mapray/src/cloud/CloudApi.ts:120

load3DDatasets

load3DDatasets(page?: number, limit?: number): Promise<Dataset3D[]>
3Dデータセットのリストを取得します。ページごとにデータセットリストを取得します。

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

loadDataset

loadDataset(datasetId: string): Promise<Dataset>
指定したIDのデータセットを取得します。

Returns
データセット
Parameters
- datasetId: string
  
  データセットのID
Returns Promise<Dataset>
- Defined in packages/mapray/src/cloud/CloudApi.ts:96

loadDatasets

loadDatasets(page?: number, limit?: number): Promise<Dataset[]>
データセットのリストを取得します。ページごとにデータセットリストを取得します。

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

loadPointCloudDataset

loadPointCloudDataset(datasetId: string): Promise<PointCloudDataset>
指定したIDの点群データセットを取得します。

Returns
点群データセット
Parameters
- datasetId: string
  
  データセットID
Returns Promise<PointCloudDataset>
- Defined in packages/mapray/src/cloud/CloudApi.ts:144

loadPointCloudDatasets

loadPointCloudDatasets(page?: number, limit?: number): Promise<PointCloudDataset[]>
点群データセットのリストを取得します。ページごとにデータセットリストを取得します。

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

loadScene

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

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

Returns
シーン
Parameters
- sceneId: string
  
  シーンのID
Returns Promise<mapray.cloud.Scene>
- Defined in packages/mapray/src/cloud/CloudApi.ts:172

loadScenes

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

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

Returns
シーンの配列
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: string, args: string[], query?: Query, body?: Body, option?: {}): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。

Returns
json
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
- Defined in packages/mapray/src/cloud/CloudApi.ts:435

`Protected` post

post<T>(api: string, args: string[], query?: Query, body?: Body, option?: {}): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。

Returns
json
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
- Defined in packages/mapray/src/cloud/CloudApi.ts:423

`Protected` put

put<T>(api: string, args: string[], query?: Query, body?: Body, option?: {}): Promise<T>
低レベルAPI。このクラスの別関数から呼び出される。

Returns
json
Type Parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
- Defined in packages/mapray/src/cloud/CloudApi.ts:447

Class CloudApiAbstract

Hierarchy

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

Returns Promise<mapray.cloud.Dataset3D.Count>

Abstract countDatasets

Returns

Returns Promise<mapray.cloud.Dataset.Count>

Abstract countPointCloudDatasets

Returns

Returns Promise<mapray.cloud.PointCloudDataset.Count>

Protected delete

Returns

Type Parameters

T

Parameters

api: string

args: string[]

Optional query: Query

option: {} = {}

Returns Promise<T>

Protected fetch

Returns

Parameters

method: string

url: string

Optional query: Query

Optional body: Body

option: RequestInit = {}

Returns Promise<Response>

Protected fetchAPI

Returns

Type Parameters

T

Parameters

method: string

api: string

args: string[]

Optional query: Query

Optional body: Body

option: {} = {}

Returns Promise<T>

Protected get

Returns

Type Parameters

T

Parameters

api: string

args: string[]

Optional query: Query

option: {} = {}

Returns Promise<T>

get3DDatasetAsResource

Returns

Parameters

datasetIds: string[]

Returns Resource

Abstract get3DDatasetScene

Returns

Parameters

datasetIds: string | string[]

Returns Promise<SceneJson>

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