[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Cloud.Googlesheet

GoogleSheet クラス

1つ以上のシートを含むGoogleスプレッドシートのスプレッドシートを表します。

各シートは、シート上のデータを CollectionView オブジェクトとして公開する Sheet オブジェクトによって表されます。 このオブジェクトは、任意のWijmoコントロールのデータソースとして使用できます。

完全なCRUDサポートに加えて、ソート、フィルタ処理、ページング、グループ化などの CollectionView 機能を使用できます。 ソート、フィルタ処理、およびページング機能は、クライアントで実行できます。

以下のコードは、3つのシートからデータを読み込む GoogleSheet オブジェクトをインスタンス化する方法を示しています。

import { GoogleSheet } from '@grapecity/wijmo.cloud';
const SHEET_ID_NW = '1qnf-FCONZj_AmOlyNkpIA3mKvP8FQtVOr7K8Awpo360';
const API_KEY = 'AIzaSyCvuXEzP57I5CQ9ifZDG2_K8M3nDa1LOPE';
let gsNWind = new GoogleSheet(SHEET_ID_NW, API_KEY, {
    sheets: [ 'Products', 'Categories', 'Suppliers' ]
});

階層

  • GoogleSheet

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

  • new GoogleSheet(sheetId: string, apiKey: string, options?: any): GoogleSheet

  • GoogleSheetクラスの新しいインスタンスを初期化します。

    引数

    • sheetId: string

      どのGoogleSheetをアクセスするかを識別するために使用されるパラメーター。 このIDは、GoogleSheetのURLの「/d/」と「/edit」の間の値です。

    • apiKey: string

      アプリケーションに関連付けられた要求を認証するために使用される識別子。 APIキーを生成するには、「https://console.cloud.google.com/」を参考してください。

    • オプション options: any

      この GoogleSheet の初期化データ（プロパティ値とイベントハンドラ）を含むJavaScriptオブジェクト。

    戻り値 GoogleSheet

プロパティ

accessToken

accessToken: string

シートへの書き込みアクセスを取得するために使用されるOAuth 2.0アクセストークンを取得または設定します。

OAuth2クラスを使用して、ユーザー認証を提供できます。 OAuth2 クラスには、ユーザーがログインできるようにするメソッドがあり、 シートへのアクセスに使用できる accessToken 文字列を提供します。

apiKey

apiKey: string

この GoogleSheet が関連付けられているAPIキーを取得します。

columnDataTypes

columnDataTypes: IColumnDataType[] | null

シートの列のデータ型を決定する IColumnDataType オブジェクトを含む配列を取得または設定します。

列のデータ型は、シートデータに基づいて自動的に決定されます。 ただし、列のデータ型を明示的に設定することもできます。 これは、空のセルまたは混合のセル型の列を含むシートで役立ちます。

以下のサンプルコードでは、GoogleSheetは「PostalCode」、「Phone」、および「Fax」という列を文字列として、 「Date」で終わる名前の列を日付として解析します。

import { DataType } from '@grapecity/wijmo';
import { GoogleSheet } from '@grapecity/google';
let ssNWind = new GoogleSheet(SHEET_ID_NW, {
    apiKey: API_KEY,
    columnDataTypes: [
        { pattern: /^(PostalCode|Phone|Fax)$/, dataType: DataType.String },
        { pattern: /Date$/, dataType: DataType.Date },
    ]
});

isLoading

isLoading: boolean

GoogleSheet が現在データをロードしていることを示す 値を取得します。

このプロパティを使用して、進捗状況インジケータを提供できます。

sheetId

sheetId: string

この GoogleSheet のIDを取得します。

sheets

sheets: ObservableArray<Sheet>

この GoogleSheet の Sheet オブジェクトのリストを取得します。

メソッド

getSheet

  • getSheet(title: string): Sheet

  • Sheet.title によって Sheet を取得します。

    引数

    • title: string

      検索するシートのタイトル。

    戻り値 Sheet

onAccessTokenChanged

onError

  • error イベントを発生させます。

    error イベントを発生させます。 デフォルトでは、エラーによって例外が生成され、データのリフレッシュがトリガされます。 この動作を回避するには、イベントハンドラでRequestErrorEventArgs.cancel パラメータをtrueに設定します。

    引数

    戻り値 boolean

onLoaded

  • loaded イベントを発生させます。

    引数

    戻り値 void

onLoading

  • loading イベントを発生させます。

    引数

    戻り値 void

イベント

accessTokenChanged

accessTokenChanged: Event<GoogleSheet, EventArgs>

accessToken プロパティの値が変更されたときに発生します。

error

error: Event<GoogleSheet, RequestErrorEventArgs>

データの読み込みまたは書き込みエラーがあるときに発生します。

loaded

loaded: Event<GoogleSheet, EventArgs>

GoogleSheet がデータのロードを終了した後に発生します。

loading

loading: Event<GoogleSheet, EventArgs>

GoogleSheet がデータのロードを開始するときに発生します。