Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudApiV2

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

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

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly basePath

basePath: string

Readonly version

version: string

Methods

count3DDatasets

countDatasets

countPointCloudDatasets

Protected delete

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

Protected fetch

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

  • 低レベル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>

  • 低レベル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>

    • 低レベルAPI。このクラスの別関数から呼び出される。

      Type parameters

      • T

      Parameters

      • api: string
      • args: string[]
      • Optional query: Query
      • option: {} = {}

        Returns Promise<T>

        json

      get3DDatasetAsResource

      • get3DDatasetAsResource(datasetIds: string[]): Resource

      get3DDatasetScene

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

      get3DDatasets

      getDataset

      getDatasetAsResource

      • getDatasetAsResource(datasetId: string): Resource

      getDatasets

      getFeatures

      getPointCloudDataset

      getPointCloudDatasetAsResource

      • getPointCloudDatasetAsResource(datasetId: string): Resource

      getPointCloudDatasets

      load3DDataset

      • load3DDataset(datasetId: string): Promise<Dataset3D>

      load3DDatasets

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

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

        Parameters

        • page: number = 1

          取得する要素のページ番号

        • limit: number = 5

          1ページに含まれる要素数。最大100まで指定することができます。

        Returns Promise<Dataset3D[]>

        3Dデータセットの配列

      loadDataset

      • loadDataset(datasetId: string): Promise<Dataset>

      loadDatasets

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

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

        Parameters

        • page: number = 1

          取得する要素のページ番号

        • limit: number = 5

          1ページに含まれる要素数。最大100まで指定することができます。

        Returns Promise<Dataset[]>

        データセットの配列

      loadPointCloudDataset

      loadPointCloudDatasets

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

        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>

      • 低レベル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>

        • 低レベル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>

          • 低レベルAPI。このクラスの別関数から呼び出される。

            Type parameters

            • T

            Parameters

            • api: string
            • args: string[]
            • Optional query: Query
            • Optional body: Body
            • option: {} = {}

              Returns Promise<T>

              json