[]
        
(Showing Draft Content)

Wijmo_Cloud.Sheet

Sheet クラス

GoogleSheet オブジェクトの個々のシートへのアクセスを提供するには、CollectionView クラスを拡張します。

Sheet オブジェクトは、 GoogleSheet オブジェクトを作成するときに sheets プロパティを設定するか、 the Sheet コンストラクターを直接呼び出すことによって作成できます。たとえば:

import { GoogleSheet, Sheet } from '@grapecity/wijmo.cloud';

// 3つのシートを含むGoogleSheetを作成します
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' ]
});

// コンストラクターを呼び出して追加のシートを作成します
let customers = new Sheet(gsNWind, 'Customers');

Sheet クラスは、データが表形式で格納されていることを前提としています。 各列の最初のセルにタイトル(一意の文字列)、 次のセルに任意のデータ型(文字列、 数値、日付、またはブール値)が含まれます 。

最初に、Sheet の作成時に Sheet データがロードされます。 その後、データはクライアントでフィルタリング、ページング、ソート、およびグループ化できます。

GoogleSheet はアクセス許可を持っている場合(GoogleSheet.accessToken プロパティを参照)、 SheetaddNewremoveeditItem メソッドを使用してCRUD操作を実行することもできます。

ほとんどのアプリケーションでは、Sheetオブジェクトは、FlexGridMultiRowグリッドなどのグリッドコントロールのデータソースとして使用されます。 例えば:

import { GoogleSheet, Sheet } from '@grapecity/wijmo.cloud';
import { FlexGrid } from '@grapecity/wijmo.cloud';

// 3つのシートを含むGoogleSheetを作成します
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' ]
});

// シートをFlexGridコントロールのitemsSourceとして使用します
let theGrid = new FlexGrid('#theGrid', {
    allowAddNew: true,
    allowDelete: true,
    itemsSource: gsNWind.getSheet('Products'),
});

Type parameters

  • T

階層

コンストラクタ

constructor

プロパティ

canAddNew

canAddNew: boolean

コレクションに新しい項目を追加できるかどうかを示す値を取得します。

canCancelEdit

canCancelEdit: boolean

適用前の変更を破棄して編集されたオブジェクトの元の値を復元できるかどうかを示す値を取得します。

canChangePage

canChangePage: boolean

pageIndex 値を変更できるかどうかを示す値を取得します。

canFilter

canFilter: boolean

このビューがfilter プロパティによってフィルタリングをサポートしているかどうかを示す値を取得します。

canGroup

canGroup: boolean

このビューがgroupDescriptions プロパティによってグループ化をサポートしているかどうかを示す値を取得します。

canRemove

canRemove: boolean

コレクションから項目を削除できるかどうかを示す値を取得します。

canSort

canSort: boolean

このビューがsortDescriptions プロパティによってソートをサポートしているかどうかを示す値を取得します。

currentAddItem

currentAddItem: T

現在の追加トランザクションの間に追加される項目を取得します。

currentEditItem

currentEditItem: T

現在の編集トランザクションの間に編集される項目を取得します。

currentItem

currentItem: T

ビューの現在の項目を取得します。

currentPosition

currentPosition: number

ビューの現在の項目の順序位置を取得します。

filter

filter: IPredicate

項目がビューに含める対象として適しているかどうかを判断するために使用されるコールバックを取得または設定します。

このコールバックがtrueを返した場合、パラメーターとして渡された項目はビューに含まれます。

filters

filters: ObservableArray<IPredicate>

このCollectionView でフィルターとして使用される{@link Ipredicate} 関数の配列を取得します。

ビューに含めるには、アイテムはfilterプロパティとfiltersコレクション内のすべての述語を渡す必要があります。

getError

getError: IGetError

項目の特定のプロパティに検証エラーが含まれているかどうかを判定するコールバックを取得または設定します。

メソッドは、データ項目をパラメータとして、検証されるプロパティ、およびデータが既に解析されてデータ項目に適用されているかどうか(解析== false)またはユーザーが値を編集しようとして予期されたデータ型に解析できない値を入力したかどうかを記述する解析パラメータ(解析== true)を受け取ります。

このメソッドは、エラーメッセージを含む文字列を返します。エラーが検出されなかった場合はnullを返します。

次に例を示します。

view = new CollectionView(data, {
    getError: (item: any, prop: string, parsing: boolean) => {

        // 「解析に失敗しました」メッセージを表示します。
        if (parsing) {
            if (prop == 'date') {
                return 'Please enter a valid date in the format "MM/dd/yyyy"';
            } else if (prop == 'id') {
                return 'Please enter a positive number';
            }
        }

        //  保存(解析)されたデータが有効であることを確認します。
        if (prop == 'date' && item.date < minDate) {
            return 'Please enter a date after ' + Globalize.formatDate(minDate, 'd');
        } else if (prop == 'id' && item.id < 0) {
            return 'Please enter a positive number';
        }
    }
});

googleSheet

googleSheet: GoogleSheet

この Sheet を含む GoogleSheet を取得します。

groupDescriptions

groupDescriptions: ObservableArray<GroupDescription>

コレクションの項目をビューでどのようにグループ化するかを記述するGroupDescription オブジェクトのコレクションを取得します。

groups

最上位レベルのグループを表すCollectionViewGroup オブジェクトの配列を取得します。

isAddingNew

isAddingNew: boolean

追加トランザクションが進行中であるかどうかを示す値を取得します。

isEditingItem

isEditingItem: boolean

編集トランザクションが進行中であるかどうかを示す値を取得します。

isEmpty

isEmpty: boolean

このビューに項目が1つも含まれていないかどうかを示す値を取得します。

isLoading

isLoading: boolean

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

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

isPageChanging

isPageChanging: boolean

ページインデックスが変更されているかどうかを示す値を取得します。

isUpdating

isUpdating: boolean

通知が現在中断されているかどうかを示す値を取得します(beginUpdate およびendUpdate を参照)。

itemCount

itemCount: number

ページングを適用する前のビューの既知の項目の数を取得します。

items

items: T[]

ビューの項目を取得します。

itemsAdded

itemsAdded: ObservableArray

trackChanges が有効化されてから、コレクションに追加されたレコードを含むObservableArray を取得します。

itemsEdited

itemsEdited: ObservableArray

trackChanges が有効化されてから、コレクションで編集されたレコードを含むObservableArray を取得します。

itemsRemoved

itemsRemoved: ObservableArray

trackChanges が有効化されてから、コレクションから削除されたレコードを含むObservableArray を取得します。

newItemCreator

newItemCreator: IItemCreator<T>

コレクションの新しい項目を作成する関数を取得または設定します。

作成関数が提供されない場合、CollectionView は、適切な型の項目を 初期化せずに作成しようとします。

作成関数が提供される場合、その関数は、パラメータを受け取らず、 コレクションに対して適切な型のオブジェクトを初期化して返す 必要があります。

pageCount

pageCount: number

総ページ数を取得します。

pageIndex

pageIndex: number

現在のページの0から始まるインデックスを取得します。

pageSize

pageSize: number

各ページに表示する項目数を取得または設定します。

このプロパティのデフォルト値は zero です。この場合、ページングが無効になります。

refreshOnEdit

refreshOnEdit: boolean

CollectionView が、アイテムの編集後に結果(ソート、フィルター、およびグループ化を適用する)を自動的に更新するかどうかを決定する値を取得または設定します。

このプロパティはデフォルトで true に設定されます。これにより、 編集が完了した後にコレクションが常に正しくソート、フィルタリング、およびグループ化されるようにします。

false に設定する場合、アイテムの編集時に更新を遅延されます。 この場合、ソート、フィルタリング、およびグループ化の基準が変更されるか、 またはExcelと同様にrefresh メソッドが呼び出されるまで、コレクションは更新されません。

sortComparer

sortComparer: IComparer<T>

ソート時に値の比較に使用する関数を取得または設定します。

指定された場合、ソート比較関数は、パラメータとして任意の型の値を 2つ取り、最初の値が2番目の値と比べて小さい、等しい、または大きい のいずれであるかを示す値-1、0、または+1を返します。ソート比較関数がnullを返す場合は、標準の組み込み比較子が使用されます。

このsortComparer プロパティを使用すると、カスタム比較アルゴリズムを 提供でき、単純な文字列比較より、ユーザーが期待する結果によく 一致するソートシーケンスが得られる場合があります。

たとえば、 Dave Koele's Alphanum algorithmを参照してください。 このアルゴリズムは、文字列を文字列や数値から成る部分に分割した後、 数値部分は値順に、文字列部分はASCII順にソートします。 Daveは、この結果を「自然なソート順」と呼んでいます。

次の例は、sortComparer プロパティの一般的な使用方法を示します。

import { CollectionView, isString } from '@grapecity/wijmo';

// カスタムソート比較子を使用してCollectionViewを作成します
const view = new CollectionView(data, {
    sortComparer: (a: any, b: any) => {
        return isString(a) && isString(b)
            ? alphanum(a, b) // 文字列に使用するカスタム比較子
            : null; // 文字列以外にはデフォルトの比較子を使用します
    }
});

次の例は、 Intl.Collator を使用してソート順を制御する方法を示しています。

import { CollectionView, isString } from '@grapecity/wijmo';

// Intl.Collatorを使用してソートするCollectionViewを作成します
const collator = window.Intl ? new Intl.Collator() : null;
let view = new CollectionView(data, {
    sortComparer: (a, b) => {
        return isString(a) && isString(b) && collator
            ? collator.compare(a, b) // 文字列に使用するカスタム比較子
            : null; // 文字列以外にはデフォルトの比較子を使用します
    }
});

sortConverter

sortConverter: ISortConverter

ソート時の値の変換に使用される関数を取得または設定します。

指定されている場合、この関数は、SortDescription、データ項目、および変換する値をパラメーターとして受け取り、 変換後の値を返す必要があります。

このプロパティはソートの動作をカスタマイズする手段を提供します。 たとえば、 FlexGrid コントロールはこのプロパティを使用して、 マップされた列を生の値ではなく表示値を基準にソートします。

以下のサンプルコードは、国コードの整数を含む'country'プロパティをソートするときに、 対応する国名を使用してソートされるようにします。

const countries = 'US,Germany,UK,Japan,Italy,Greece'.split(',');
view.sortConverter = (sd: SortDescription, item: any, value: any) => {
    return sd.property === 'countryMapped'
        ? countries[value]; // convert country id into name
        : value;
}

次の例では、2つの値を組み合わせています。 この場合、国でソートすると、ビューが都市ごとに分割されます。

view.sortConverter: (sd: SortDescription, item: any, value: any) => {
    if (sd.property == 'country') {
        value = item.country + '\t' + item.city;
    }
    return value;
}

sortDescriptions

sortDescriptions: ObservableArray<SortDescription>

コレクションの項目をビューでどのようにソートするかを記述するSortDescription オブジェクトの配列を取得します。

sortNulls

sortNulls: SortNulls

null値のソート方法を決定する値を取得または設定します。

このプロパティはデフォルトでLastに設定されます。これにより、コレクションをソートすると、並べ替えの方向に関係なくNULL値が最後に表示されます。 この動作はExcelと同じです。

sourceCollection

sourceCollection: any

基になる(フィルタリングもソートもされていない)コレクションを取得または設定します。

title

title: string

この Sheet のタイトルを取得します。

totalItemCount

totalItemCount: number

ページングを適用する前のビュー内の項目の合計数を取得します。

trackChanges

trackChanges: boolean

コントロールがデータの変更を追跡するかどうかを決定する値を取得または設定します。

trackChanges がtrueに設定されている場合、CollectionView は、 データの変更を追跡し、itemsAddeditemsRemoveditemsEdited の 各コレクションを介して変更を公開します。変更の追跡は、変更が有効であることをユーザーが確認した後にサーバーを更新する必要がある場合に役立ちます。

変更をコミットまたはキャンセルしたら、clearChanges メソッドを使用して、 itemsAddeditemsRemoveditemsEdited の各コレクションをクリアします。 CollectionView は、適切なCollectionView メソッド(editItem /commitEditaddNew /commitNewremove)を使用して行われた変更だけを追跡します。 データに直接行われた変更は追跡されません。

useStableSort

useStableSort: boolean

安定したソートアルゴリズムを使用するかどうかを取得または設定します。

安定したソートアルゴリズムは、同じキーを持つレコード間の相対的な順序を維持します。 たとえば、"Amount"フィールドを持つオブジェクトのコレクションを考えてみます。 このコレクションを"Amount"でソートする場合、安定したソートでは、 Amount値が同じレコード間で元の順序が保たれます。

このプロパティのデフォルトは false です。この場合は、 高速だが安定ではないJavaScriptの組み込みソートメソッドが CollectionView で使用されます。

useStableSort をtrueに設定すると、すべてのブラウザーで安定したソートが保証されますが、ソート時間が30%~50%も長くなります。

注意:Chromeはバージョン70以降、Firefoxバージョン3以降は安定したソートを提供します。 ES2019の場合 、ソートは安定している必要があります。 ES2018までのECMAScript第1版では、不安定になることが許可されていました。

ES2018までの仕様では、安定したソートアルゴリズムを使用すべきかどうかは定義されていなかったため、 ブラウザによってソートアルゴリズムの安定性は異なっていました。ES2019では、安定したソートアルゴリズムを使用しなければならないと仕様で定義され、 バージョン70以降のChromeなどで安定したソートアルゴリズムが実装されています。安定したソートアルゴリズムが実装されたブラウザでは、 useStableSortの値に関わらず安定したソートアルゴリズムが使用されるため、useStableSortをtrueに設定する必要はありません。

メソッド

addNew

  • addNew(item?: T, commit?: boolean): T
  • コレクションに新しい項目を追加します。

    このメソッドをパラメータなしで呼び出すと、新しい項目が作成されてコレクションに追加され、 commitNewメソッドで新しい項目がコミットされるか、 cancelNewメソッドでキャンセルされるまで、リフレッシュ操作が保留されます。

    次のコードは、addNew メソッドの典型的な使用方法を示します。

    // 新しい項目を作成し、それをコレクションに追加します
    var newItem = view.addNew();
    
    // 新しい項目を初期化します
    newItem.id = getFreshId();
    newItem.name = '新しい顧客';
    
    // ビューをリフレッシュできるように新しい項目をコミットします
    view.commitNew();

    新しい項目をsourceCollection にプッシュしてから、refresh メソッドを呼び出すことで、 新しい項目を追加することもできます。addNew では、 ユーザーが追加操作をキャンセルできるため、ユーザー対話式のシナリオ(データグリッドに新しい項目の追加するなど)で特に便利です。 また、追加操作がコミットされるまで、新しい項目がソートされたり、 フィルタ処理でビューから除外されないようにします。

    引数

    • オプション item: T

      コレクションに追加する項目(オプション)。

    • オプション commit: boolean

      新しい項目をすぐにコミットするかどうか。

    戻り値 T

    現在の追加トランザクションを終了し、追加前の新しい項目を保存します。

beginUpdate

  • beginUpdate(): void

cancelEdit

  • cancelEdit(): void

cancelNew

  • cancelNew(): void

clearChanges

  • clearChanges(): void
  • itemsAddeditemsRemoveditemsEdited の各コレクションの全項目をクリアすることによってすべての変更をクリアします。

    このメソッドは、変更をサーバーに確定した後またはデータをサーバーから更新した後に呼び出します。

    戻り値 void

commitEdit

  • commitEdit(): void

commitNew

  • commitNew(): void

contains

  • contains(item: T): boolean

deferUpdate

  • deferUpdate(fn: Function, force?: boolean): void
  • beginUpdate/endUpdate ブロック内で関数を実行します。

    この関数が終了するまでコレクションはリフレッシュされません。 deferUpdateメソッドは、update関数が例外を生成した場合でもendUpdate が呼び出されるようにします。

    引数

    • fn: Function

      更新なしで実行する関数。

    • オプション force: boolean

      更新の終了時に強制的に更新するかどうか。

    戻り値 void

editItem

  • editItem(item: T): void
  • 指定した項目の編集トランザクションを開始します。

    引数

    • item: T

      編集する項目。

    戻り値 void

endUpdate

  • endUpdate(force?: boolean): void

getAggregate

  • getAggregate(aggType: Aggregate, binding: string, currentPage?: boolean): any
  • このコレクション内の項目の集計値を計算します。

    引数

    • aggType: Aggregate

      計算する集計のタイプ。

    • binding: string

      集計するプロパティ。

    • オプション currentPage: boolean

      現在のページの項目だけを含めるかどうか。

    戻り値 any

    集計値。

implementsInterface

  • implementsInterface(interfaceName: string): boolean

load

  • load(keepPosition?: boolean): void
  • シートのデータをロードまたは再ロードします。

    引数

    • オプション keepPosition: boolean

      カーソル位置を維持したままにするかどうか。

    戻り値 void

moveCurrentTo

  • moveCurrentTo(item: T): boolean

moveCurrentToFirst

  • moveCurrentToFirst(): boolean

moveCurrentToLast

  • moveCurrentToLast(): boolean

moveCurrentToNext

  • moveCurrentToNext(): boolean

moveCurrentToPosition

  • moveCurrentToPosition(index: number): boolean

moveCurrentToPrevious

  • moveCurrentToPrevious(): boolean

moveToFirstPage

  • moveToFirstPage(): boolean

moveToLastPage

  • moveToLastPage(): boolean

moveToNextPage

  • moveToNextPage(): boolean

moveToPage

  • moveToPage(index: number): boolean
  • 指定したインデックスにあるページに移動します。

    引数

    • index: number

      移動先ページのインデックス。

    戻り値 boolean

    ページのインデックスが正常に変更された場合はTrue。

moveToPreviousPage

  • moveToPreviousPage(): boolean

onCollectionChanged

onCurrentChanged

onCurrentChanging

onError

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

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

    引数

    戻り値 boolean

onLoaded

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

    引数

    戻り値 void

onLoading

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

    引数

    戻り値 boolean

    イベントがキャンセルされなかった場合はTrue。

onPageChanged

onPageChanging

onSourceCollectionChanged

  • onSourceCollectionChanged(e?: EventArgs): void

onSourceCollectionChanging

refresh

  • refresh(): void

remove

  • remove(item: any): void

removeAt

  • removeAt(index: number): void
  • 指定したインデックスにある項目をコレクションから削除します。

    引数

    • index: number

      コレクションから削除する項目のインデックス。このインデックスは、ソースコレクションに対してではなくビューに対する相対インデックスです。

    戻り値 void

イベント

collectionChanged

コレクションが変更されたときに発生します。

currentChanged

currentChanged: Event<CollectionView<T>, EventArgs>

現在の項目が変更された後に発生します。

currentChanging

currentChanging: Event<CollectionView<T>, CancelEventArgs>

現在の項目が変更される前に発生します。

error

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

loaded

Sheet がデータのロードを終了したときに発生します。

loading

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

pageChanged

pageChanged: Event<CollectionView<T>, EventArgs>

ページインデックスが変更された後に発生します。

pageChanging

ページインデックスが変更される前に発生します。

sourceCollectionChanged

sourceCollectionChanged: Event<CollectionView<T>, EventArgs>

sourceCollection プロパティの値が変化した後に発生します。

sourceCollectionChanging

sourceCollectionChanging: Event<CollectionView<T>, CancelEventArgs>

sourceCollection プロパティの値が変化する前に発生します。