CloudApiV2¶

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

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

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

Extends¶

CloudApi

Constructors¶

new CloudApiV2()¶

new CloudApiV2(option): CloudApiV2

Parameters¶

Parameter	Type
`option`	`Option`

Returns¶

CloudApiV2

Overrides¶

CloudApi.constructor

Properties¶

basePath¶

readonly basePath: string

Inherited from¶

CloudApi.basePath

version¶

readonly version: string

Inherited from¶

CloudApi.version

Methods¶

count3DDatasets()¶

count3DDatasets(): Promise<Count>

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

Returns¶

Promise<Count>

json

Overrides¶

CloudApi.count3DDatasets

countB3dDatasets()¶

countB3dDatasets(): Promise<Count>

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

Returns¶

Promise<Count>

json

Overrides¶

CloudApi.countB3dDatasets

countDatasets()¶

countDatasets(): Promise<Count>

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

Returns¶

Promise<Count>

json

Overrides¶

CloudApi.countDatasets

countDemDatasets()¶

countDemDatasets(): Promise<Count>

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

Returns¶

Promise<Count>

json

Overrides¶

CloudApi.countDemDatasets

countPointCloudDatasets()¶

countPointCloudDatasets(): Promise<Count>

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

Returns¶

Promise<Count>

json

Overrides¶

CloudApi.countPointCloudDatasets

countTilesetDatasets()¶

countTilesetDatasets(): Promise<Count>

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

Returns¶

Promise<Count>

json

Overrides¶

CloudApi.countTilesetDatasets

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

Inherited from¶

CloudApi.delete

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

Inherited from¶

CloudApi.fetch

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

Inherited from¶

CloudApi.fetchAPI

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

Inherited from¶

CloudApi.get

get3DDatasetAsResource()¶

get3DDatasetAsResource(datasetId)¶

get3DDatasetAsResource(datasetId): Dataset3DResource

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

Parameters¶

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

Returns¶

Dataset3DResource

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

Inherited from¶

CloudApi.get3DDatasetAsResource

get3DDatasetAsResource(datasetIds)¶

get3DDatasetAsResource(datasetIds): Dataset3DResource

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

Parameters¶

Parameter	Type
`datasetIds`	`string`[]

Returns¶

Dataset3DResource

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

Inherited from¶

CloudApi.get3DDatasetAsResource

Deprecated¶

get3DDatasetScene()¶

get3DDatasetScene(datasetIds): Promise<SceneJson>

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

Parameters¶

Parameter	Type	Description
`datasetIds`	`string` \| `string`[]

Returns¶

Promise<SceneJson>

シーンファイルの実体

Overrides¶

CloudApi.get3DDatasetScene

get3DDatasets()¶

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

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

Parameters¶

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

Returns¶

Promise<Json[]>

json

Overrides¶

CloudApi.get3DDatasets

getB3dDataset()¶

getB3dDataset(datasetId): Promise<Json>

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

Parameters¶

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

Returns¶

Promise<Json>

json

Overrides¶

CloudApi.getB3dDataset

getB3dDatasetAsResource()¶

getB3dDatasetAsResource(datasetId): B3dDatasetResource

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

Parameters¶

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

Returns¶

B3dDatasetResource

B3Dデータのリソース

Inherited from¶

CloudApi.getB3dDatasetAsResource

getB3dDatasets()¶

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

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

Parameters¶

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

Returns¶

Promise<Json[]>

json

Overrides¶

CloudApi.getB3dDatasets

getDataset()¶

getDataset(datasetId): Promise<Json>

get dataset

Parameters¶

Parameter	Type	Description
`datasetId`	`string`

Returns¶

Promise<Json>

json

Overrides¶

CloudApi.getDataset

getDatasetAsResource()¶

getDatasetAsResource(datasetId): DatasetResource

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

Parameters¶

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

Returns¶

DatasetResource

データセットのリソース

Inherited from¶

CloudApi.getDatasetAsResource

getDatasetFeaturesAsResource()¶

getDatasetFeaturesAsResource(datasetId): DatasetFeaturesResource

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

Parameters¶

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

Returns¶

DatasetFeaturesResource

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

Inherited from¶

CloudApi.getDatasetFeaturesAsResource

getDatasets()¶

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

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

Parameters¶

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

Returns¶

Promise<Json[]>

json[]

Overrides¶

CloudApi.getDatasets

getDefaultDemAsResource()¶

getDefaultDemAsResource(): Resource

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

Returns¶

Resource

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

Inherited from¶

CloudApi.getDefaultDemAsResource

getDemDataset()¶

getDemDataset(datasetId): Promise<Json>

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

Parameters¶

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

Returns¶

Promise<Json>

json

Overrides¶

CloudApi.getDemDataset

getDemDatasetAsResource()¶

getDemDatasetAsResource(datasetId): DemDatasetResource

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

Parameters¶

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

Returns¶

DemDatasetResource

Demデータのリソース

Inherited from¶

CloudApi.getDemDatasetAsResource

getDemDatasets()¶

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

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

Parameters¶

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

Returns¶

Promise<Json[]>

json

Overrides¶

CloudApi.getDemDatasets

getFeatures()¶

getFeatures(datasetId): Promise<FeatureCollectionJson>

GeoJSONの内容を取得します。

Parameters¶

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

Returns¶

Promise<FeatureCollectionJson>

json

Overrides¶

CloudApi.getFeatures

getPointCloudDataset()¶

getPointCloudDataset(datasetId): Promise<Json>

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

Parameters¶

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

Returns¶

Promise<Json>

json

Overrides¶

CloudApi.getPointCloudDataset

getPointCloudDatasetAsResource()¶

getPointCloudDatasetAsResource(datasetId): PointCloudDatasetResource

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

Parameters¶

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

Returns¶

PointCloudDatasetResource

点群データのリソース

Inherited from¶

CloudApi.getPointCloudDatasetAsResource

getPointCloudDatasets()¶

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

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

Parameters¶

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

Returns¶

Promise<Json[]>

json

Overrides¶

CloudApi.getPointCloudDatasets

getScene()¶

getScene(sceneId): Promise<Json>

シーンを取得します。

Parameters¶

Parameter	Type	Description
`sceneId`	`string`	シーンId

Returns¶

Promise<Json>

json

Overrides¶

CloudApi.getScene

getSceneAsResource()¶

getSceneAsResource(sceneId): SceneResource

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

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

Parameters¶

Parameter	Type	Description
`sceneId`	`string`	シーンID

Returns¶

SceneResource

シーンのリソース

Inherited from¶

CloudApi.getSceneAsResource

getSceneContent()¶

getSceneContent(sceneId): Promise<SceneJson>

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

Parameters¶

Parameter	Type	Description
`sceneId`	`string`	シーンId

Returns¶

Promise<SceneJson>

json

Overrides¶

CloudApi.getSceneContent

getScenes()¶

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

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

Parameters¶

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

Returns¶

Promise<Json[]>

json

Overrides¶

CloudApi.getScenes

getTilesetDatasetAsResource()¶

getTilesetDatasetAsResource(datasetId): TilesetDatasetResource

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

Parameters¶

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

Returns¶

TilesetDatasetResource

Tilesetデータのリソース

Inherited from¶

CloudApi.getTilesetDatasetAsResource

getTilesetDatasets()¶

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

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

Parameters¶

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

Returns¶

Promise<Json[]>

json

Overrides¶

CloudApi.getTilesetDatasets

getVectile()¶

getVectile(datasetId): Promise<Json>

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

Parameters¶

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

Returns¶

Promise<Json>

json

Overrides¶

CloudApi.getVectile

getVectileDatasetAsResource()¶

getVectileDatasetAsResource(datasetId): VectileDatasetResource

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

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

Parameters¶

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

Returns¶

VectileDatasetResource

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

Inherited from¶

CloudApi.getVectileDatasetAsResource

load3DDataset()¶

load3DDataset(datasetId): Promise<Dataset3D>

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

Parameters¶

Parameter	Type	Description
`datasetId`	`string`

Returns¶

Promise<Dataset3D>

3Dデータセット

Inherited from¶

CloudApi.load3DDataset

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データセットの配列

Inherited from¶

CloudApi.load3DDatasets

loadB3dDataset()¶

loadB3dDataset(datasetId): Promise<B3dDataset>

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

Parameters¶

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

Returns¶

Promise<B3dDataset>

B3Dデータセット

Inherited from¶

CloudApi.loadB3dDataset

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データセットの配列

Inherited from¶

CloudApi.loadB3dDatasets

loadDataset()¶

loadDataset(datasetId): Promise<Dataset>

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

Parameters¶

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

Returns¶

Promise<Dataset>

データセット

Inherited from¶

CloudApi.loadDataset

loadDatasets()¶

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

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

Parameters¶

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

Returns¶

Promise<Dataset[]>

データセットの配列

Inherited from¶

CloudApi.loadDatasets

loadDemDataset()¶

loadDemDataset(datasetId): Promise<DemDataset>

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

Parameters¶

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

Returns¶

Promise<DemDataset>

Demデータセット

Inherited from¶

CloudApi.loadDemDataset

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データセットの配列

Inherited from¶

CloudApi.loadDemDatasets

loadPointCloudDataset()¶

loadPointCloudDataset(datasetId): Promise<PointCloudDataset>

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

Parameters¶

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

Returns¶

Promise<PointCloudDataset>

点群データセット

Inherited from¶

CloudApi.loadPointCloudDataset

loadPointCloudDatasets()¶

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

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

Parameters¶

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

Returns¶

Promise<PointCloudDataset[]>

点群データセットの配列

Inherited from¶

CloudApi.loadPointCloudDatasets

loadScene()¶

loadScene(sceneId): Promise<Scene>

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

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

Parameters¶

Parameter	Type	Description
`sceneId`	`string`	シーンのID

Returns¶

Promise<Scene>

シーン

Inherited from¶

CloudApi.loadScene

loadScenes()¶

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

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

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

Parameters¶

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

Returns¶

Promise<Scene[]>

シーンの配列

Inherited from¶

CloudApi.loadScenes

loadTilesetDataset()¶

loadTilesetDataset(datasetId): Promise<TilesetDataset>

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

Parameters¶

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

Returns¶

Promise<TilesetDataset>

Tilesetデータセット

Inherited from¶

CloudApi.loadTilesetDataset

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データセットの配列

Inherited from¶

CloudApi.loadTilesetDatasets

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

Inherited from¶

CloudApi.patch

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

Inherited from¶

CloudApi.post

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

Inherited from¶

CloudApi.put