Class CloudApiV2

Version 2 で CloudApi へ接続するためのクラスです。使い方は継承元クラスの説明も参照。

const cloudApi = new mapray.cloud.CloudApiV2({
        tokenType: CloudApi.TokenType.API_KEY,
        userId: "...",
        token: "...",
});

const datasets = await cloudApi.getDatasets();
// ...

Hierarchy

CloudApi
- CloudApiV2

Constructors

constructor

new CloudApiV2(option: mapray.cloud.CloudApiV2.Option): CloudApiV2
Parameters
- option: mapray.cloud.CloudApiV2.Option
Returns CloudApiV2
Overrides CloudApi.constructor
- Defined in packages/mapray/src/cloud/CloudApiV2.ts:24

Properties

`Readonly` basePath

basePath: string

`Readonly` version

version: string

Methods

count3DDatasets

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

Returns
json

Returns Promise<mapray.cloud.Dataset3D.Count>
Overrides CloudApi.count3DDatasets
- Defined in packages/mapray/src/cloud/CloudApiV2.ts:146

countDatasets

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

Returns
json

Returns Promise<mapray.cloud.Dataset.Count>
Overrides CloudApi.countDatasets
- Defined in packages/mapray/src/cloud/CloudApiV2.ts:50

countPointCloudDatasets

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

Returns
json

Returns Promise<mapray.cloud.PointCloudDataset.Count>
Overrides CloudApi.countPointCloudDatasets
- Defined in packages/mapray/src/cloud/CloudApiV2.ts:270

`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>
Inherited from CloudApi.delete
- 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>
Inherited from CloudApi.fetch
- 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>
Inherited from CloudApi.fetchAPI
- 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>
Inherited from CloudApi.get
- Defined in packages/mapray/src/cloud/CloudApi.ts:414

get3DDatasetAsResource

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

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

get3DDatasetScene

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

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

get3DDatasets

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

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

getDataset

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

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

getDatasetAsResource

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

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

getDatasets

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

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

getFeatures

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

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

getPointCloudDataset

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

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

getPointCloudDatasetAsResource

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

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

getPointCloudDatasets

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

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

getScene

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

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

getSceneAsResource

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

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

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

getSceneContent

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

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

getScenes

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

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

load3DDataset

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

Returns
3Dデータセット
Parameters
- datasetId: string
Returns Promise<Dataset3D>
Inherited from CloudApi.load3DDataset
- 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[]>
Inherited from CloudApi.load3DDatasets
- Defined in packages/mapray/src/cloud/CloudApi.ts:109

loadDataset

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

Returns
データセット
Parameters
- datasetId: string
  
  データセットのID
Returns Promise<Dataset>
Inherited from CloudApi.loadDataset
- 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[]>
Inherited from CloudApi.loadDatasets
- Defined in packages/mapray/src/cloud/CloudApi.ts:85

loadPointCloudDataset

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

Returns
点群データセット
Parameters
- datasetId: string
  
  データセットID
Returns Promise<PointCloudDataset>
Inherited from CloudApi.loadPointCloudDataset
- 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[]>
Inherited from CloudApi.loadPointCloudDatasets
- 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>
Inherited from CloudApi.loadScene
- 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[]>
Inherited from CloudApi.loadScenes
- 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>
Inherited from CloudApi.patch
- 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>
Inherited from CloudApi.post
- 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>
Inherited from CloudApi.put
- Defined in packages/mapray/src/cloud/CloudApi.ts:447

Class CloudApiV2

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

option: mapray.cloud.CloudApiV2.Option

Returns CloudApiV2

Properties

Readonly basePath

Readonly version

Methods

count3DDatasets

Returns

Returns Promise<mapray.cloud.Dataset3D.Count>

countDatasets

Returns

Returns Promise<mapray.cloud.Dataset.Count>

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

get3DDatasetScene

Returns

Parameters

datasetIds: string | string[]

Returns Promise<SceneJson>

get3DDatasets

Returns

Parameters

page: number = 1

limit: number = 5

`Readonly` basePath

`Readonly` version

`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