CloudApi | @mapray

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

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

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>

- Defined in packages/mapray/src/cloud/CloudApi.ts:267
登録されている3Dデータセットの数を取得します

Returns Promise<mapray.cloud.Dataset3D.Count>
json

Abstract countDatasets

countDatasets(): Promise<mapray.cloud.Dataset.Count>

- Defined in packages/mapray/src/cloud/CloudApi.ts:198
登録されているデータセットの数を取得します

Returns Promise<mapray.cloud.Dataset.Count>
json

Abstract countPointCloudDatasets

countPointCloudDatasets(): Promise<mapray.cloud.PointCloudDataset.Count>

- Defined in packages/mapray/src/cloud/CloudApi.ts:333
登録されている点群データセットの数を取得します

Returns Promise<mapray.cloud.PointCloudDataset.Count>
json

Protected delete

delete<T>(api: string, args: string[], query?: Query, option?: {}): Promise<T>

- Defined in packages/mapray/src/cloud/CloudApi.ts:391
低レベルAPI。このクラスの別関数から呼び出される。

Type parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- option: {} = {}
Returns Promise<T>
json

Protected fetch

fetch(method: string, url: string, query?: Query, body?: Body, option?: RequestInit): Promise<Response>

- Defined in packages/mapray/src/cloud/CloudApi.ts:413
低レベルAPI。このクラスの別関数から呼び出される。

Parameters
- method: string
- url: string
- Optional query: Query
- Optional body: Body
- option: RequestInit = {}
Returns Promise<Response>
json

Protected fetchAPI

fetchAPI<T>(method: string, api: string, args: string[], query?: Query, body?: Body, option?: {}): Promise<T>

- Defined in packages/mapray/src/cloud/CloudApi.ts:400
低レベルAPI。このクラスの別関数から呼び出される。

Type parameters
- T
Parameters
- method: string
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
json

Protected get

get<T>(api: string, args: string[], query?: Query, option?: {}): Promise<T>

- Defined in packages/mapray/src/cloud/CloudApi.ts:346
低レベルAPI。このクラスの別関数から呼び出される。

Type parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- option: {} = {}
Returns Promise<T>
json

get3DDatasetAsResource

get3DDatasetAsResource(datasetIds: string[]): Resource

- Defined in packages/mapray/src/cloud/CloudApi.ts:168
指定したIDの3Dデータセットのシーンファイルをリソースとして取得します。

Parameters
- datasetIds: string[]
Returns Resource
3Dデータセットのリソース

Abstract get3DDatasetScene

get3DDatasetScene(datasetIds: string | string[]): Promise<SceneJson>

- Defined in packages/mapray/src/cloud/CloudApi.ts:319
3Dデータセットに含まれる scene情報を取得します。

Parameters
- datasetIds: string | string[]
Returns Promise<SceneJson>
シーンファイルの実体

Abstract get3DDatasets

get3DDatasets(page: number, limit: number): Promise<mapray.cloud.Dataset3D.Json[]>

- Defined in packages/mapray/src/cloud/CloudApi.ts:261
3Dデータセットのリストを取得します。

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

Abstract getDataset

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

- Defined in packages/mapray/src/cloud/CloudApi.ts:205
get dataset

Parameters
- datasetId: string
Returns Promise<mapray.cloud.Dataset.Json>
json

getDatasetAsResource

getDatasetAsResource(datasetId: string): Resource

- Defined in packages/mapray/src/cloud/CloudApi.ts:158
指定したIDのデータセットをリソースとして取得します。

Parameters
- datasetId: string
  
  データセットID
Returns Resource
データセットのリソース

Abstract getDatasets

getDatasets(page: number, limit: number): Promise<mapray.cloud.Dataset.Json[]>

- Defined in packages/mapray/src/cloud/CloudApi.ts:192
データセットリストを取得します

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

Abstract getFeatures

getFeatures(datasetId: string): Promise<FeatureCollectionJson>

- Defined in packages/mapray/src/cloud/CloudApi.ts:227
GeoJSONの内容を取得します。

Parameters
- datasetId: string
  
  データセットID
Returns Promise<FeatureCollectionJson>
json

Abstract getPointCloudDataset

getPointCloudDataset(datasetId: string): Promise<mapray.cloud.PointCloudDataset.Json>

- Defined in packages/mapray/src/cloud/CloudApi.ts:340
点群データセットを取得します。

Parameters
- datasetId: string
  
  データセットId
Returns Promise<mapray.cloud.PointCloudDataset.Json>
json

getPointCloudDatasetAsResource

getPointCloudDatasetAsResource(datasetId: string): Resource

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

Parameters
- datasetId: string
  
  データセットID
Returns Resource
点群データのリソース

Abstract getPointCloudDatasets

getPointCloudDatasets(page: number, limit: number): Promise<mapray.cloud.PointCloudDataset.Json[]>

- Defined in packages/mapray/src/cloud/CloudApi.ts:327
点群データセットリストを取得します。

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

load3DDataset

load3DDataset(datasetId: string): Promise<Dataset3D>

- Defined in packages/mapray/src/cloud/CloudApi.ts:120
指定したIDの3Dデータセットを取得します。

Parameters
- datasetId: string
Returns Promise<Dataset3D>
3Dデータセット

load3DDatasets

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

- Defined in packages/mapray/src/cloud/CloudApi.ts:109
3Dデータセットのリストを取得します。ページごとにデータセットリストを取得します。

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

loadDataset

loadDataset(datasetId: string): Promise<Dataset>

- Defined in packages/mapray/src/cloud/CloudApi.ts:96
指定したIDのデータセットを取得します。

Parameters
- datasetId: string
  
  データセットのID
Returns Promise<Dataset>
データセット

loadDatasets

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

- Defined in packages/mapray/src/cloud/CloudApi.ts:85
データセットのリストを取得します。ページごとにデータセットリストを取得します。

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

loadPointCloudDataset

loadPointCloudDataset(datasetId: string): Promise<PointCloudDataset>

- Defined in packages/mapray/src/cloud/CloudApi.ts:144
指定したIDの点群データセットを取得します。

Parameters
- datasetId: string
  
  データセットID
Returns Promise<PointCloudDataset>
点群データセット

loadPointCloudDatasets

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

- Defined in packages/mapray/src/cloud/CloudApi.ts:133
点群データセットのリストを取得します。ページごとにデータセットリストを取得します。

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

Protected patch

patch<T>(api: string, args: string[], query?: Query, body?: Body, option?: {}): Promise<T>

- Defined in packages/mapray/src/cloud/CloudApi.ts:367
低レベルAPI。このクラスの別関数から呼び出される。

Type parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
json

Protected post

post<T>(api: string, args: string[], query?: Query, body?: Body, option?: {}): Promise<T>

- Defined in packages/mapray/src/cloud/CloudApi.ts:355
低レベルAPI。このクラスの別関数から呼び出される。

Type parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
json

Protected put

put<T>(api: string, args: string[], query?: Query, body?: Body, option?: {}): Promise<T>

- Defined in packages/mapray/src/cloud/CloudApi.ts:379
低レベルAPI。このクラスの別関数から呼び出される。

Type parameters
- T
Parameters
- api: string
- args: string[]
- Optional query: Query
- Optional body: Body
- option: {} = {}
Returns Promise<T>
json

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 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>

getDatasetAsResource