[]
Snapshotクラスの新しいインスタンスを初期化します。
Firestoreクライアントライブラリの CollectionRef オブジェクト。
この Snapshot の初期化データ(プロパティ値とイベントハンドラー)を含むJavaScriptオブジェクト。
例えば、
// FirestoreクライアントSDKを初期化します
const firebaseConfig = {
apiKey: "...",
...
};
firebase.initializeApp(firebaseConfig);
const db = firebase.firestore();
// 「レストラン」コレクションのスナップショットを作成します
// レストランの種類は「日本料理」または「イタリア料理」です。
const restaurants = db.collection('レストラン');
const view = new Snapshot(restaurants, {
query: restaurants.where('種類', 'in', ['日本料理', 'イタリア料理' ])
});
キーが計算フィールドを表し、値が式(関数または文字列)であるオブジェクトを取得または設定します。
計算フィールドにはプロキシが必要になります。 Ie11で使用する場合は、 https://www.npmjs.com/package/proxy-polyfill のようなポリフィルを使用します。
計算フィールドは、外部データを扱う場合に役立ちます。 たとえば、1人当たりの収入フィールド(gnp/pop)または利益フィールド(収益-経費)を追加できます。
計算フィールドは動的です。 計算で使用されるフィールドを変更すると、それらの値は自動的に更新されます。 また、読み取り専用です。 それらの計算に使用されるプロパティの値を変更することはできますが、結果を直接編集することはできません。
FlexGrid cellTemplatesとは異なり、計算フィールドは並べ替え、フィルタリング、およびグループ化に使用できます。 また、チャートやその他のWijmoコントロールで使用することもできます。
計算フィールドは、データ項目を引数または文字列として受け取る関数として定義できます。
以下に例を示します。
// 通常のデータ項目
interface IDataItem {
product: string,
brand: string,
unitPrice: number,
qty: number,
shipped: boolean
}
function getData(): IDataItem[] {
return [
{
product: 'Banana',
brand: 'Chiquita',
unitPrice: 45.95,
qty: 12,
discount: .08,
shipped: true
}, ...
]
}
次のように関数ベースの計算フィールドを追加できます。
// 計算プロパティをIDataItemに追加します
interface ICalcDataItem extends IDataItem {
fullName: string;
allCaps: string;
totalPrice: number,
tax: number;
}
let cv = new CollectionView<ICalcDataItem>(getData(), {
calculatedFields: {
fullName: ($: ICalcDataItem) => [$.brand, $.product].join(' '),
allCaps: ($: ICalcDataItem) => $.fullName.toUpperCase(),
totalPrice: ($: ICalcDataItem) => ($.unitPrice * $.qty) * (1 - $.discount),
tax: ($: ICalcDataItem) => $.totalPrice * 0.12
}
});
関数ベースの計算フィールドは、次の理由により、通常、文字列ベースの計算フィールドよりも優れています。
1)設計時のエラーチェックとコマンド補完を提供します。 2)実行速度が速い 3)コンテンツセキュリティポリシー(CSP)に関する問題はありません。
あるいは、文字列ベースの計算フィールドを追加することもできます。
let cv = new CollectionView<IDataItem>(getData(), {
calculatedFields: {
fullName: '[$.brand, $.product].join(" ")',
allCaps: '$.fullNameStr.toUpperCase()',
totalPrice: '($.unitPrice * $.qty) * (1 - $.discount)',
tax: '$.totalPrice * 0.12'
});
文字列式は、 項目の元の値と計算された値を含む コンテキスト変数「$」により、現在の項目を参照できます。 文字列ベースの計算フィールドには、関数ベースの計算フィールドよりも利点があり、場合によっては重要になることがあります。 いくつかの利点は次のとおりです。
1)少し簡潔です 2)データとして保存でき、実行時に簡単に変更できます。
コレクションに新しい項目を追加できるかどうかを示す値を取得します。
適用前の変更を破棄して編集されたオブジェクトの元の値を復元できるかどうかを示す値を取得します。
pageIndex 値を変更できるかどうかを示す値を取得します。
このビューがgroupDescriptions プロパティによってグループ化をサポートしているかどうかを示す値を取得します。
コレクションから項目を削除できるかどうかを示す値を取得します。
このビューがsortDescriptions プロパティによってソートをサポートしているかどうかを示す値を取得します。
現在の追加トランザクションの間に追加される項目を取得します。
現在の編集トランザクションの間に編集される項目を取得します。
ビューの現在の項目を取得します。
ビューの現在の項目の順序位置を取得します。
Snapshotがコミットをデータベースに戻す値を取得または設定します。
このプロパティのデフォルト値はfalseです。 これにより、データへの変更がデータベースにすぐにコミットされます。 このプロパティをtrueに設定すると、自動的にtrackChangesプロパティがtrueに設定されます。 その後に、データの変更(編集、追加、削除を含む)は追跡されますが、 commitChangesメソッドを呼び出して変更をコミットするか、 cancelChangesメソッドを呼び出して保留中の変更をすべて破棄するまで、データベースにコミットされません。
項目がビューに含める対象として適しているかどうかを判断するために使用されるコールバックを取得または設定します。
パラメータとして渡された項目を画面に表示する必要がある場合、コールバックはtrueを返します。
このプロパティのデフォルト値はnullです。これは、データがフィルタリングされないことを意味します。
このCollectionView でフィルターとして使用される{@link Ipredicate} 関数の配列を取得します。
項目の特定のプロパティに検証エラーが含まれているかどうかを判定するコールバックを取得または設定します。
メソッドは、データ項目をパラメータとして、検証されるプロパティ、およびデータが既に解析されてデータ項目に適用されているかどうか(parsing == false)またはユーザーが値を編集しようとして予期されたデータ型に解析できない値を入力したかどうかを記述する解析パラメータ(parsing == 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';
}
}
});
コレクションの項目をビューでどのようにグループ化するかを記述するGroupDescription オブジェクトのコレクションを取得します。
最上位レベルのグループを表すCollectionViewGroup オブジェクトの配列を取得します。
Snapshotに保留中の変更があるかどうかを決定する値を取得します。
詳細については、deferCommits プロパティ、commitChanges および cancelChanges メソッドも参照してください。
追加トランザクションが進行中であるかどうかを示す値を取得します。
編集トランザクションが進行中であるかどうかを示す値を取得します。
このビューに項目が1つも含まれていないかどうかを示す値を取得します。
Snapshot が現在データをロードしていることを示す 値を取得します。
このプロパティを使用して、進捗状況インジケータを提供できます。
ページインデックスが変更されているかどうかを示す値を取得します。
通知が現在中断されているかどうかを示す値を取得します(beginUpdate およびendUpdate を参照)。
ページングを適用する前のビューの既知の項目の数を取得します。
ビューの項目を取得します。
trackChanges が有効化されてから、コレクションに追加されたレコードを含むObservableArray を取得します。
trackChanges が有効化されてから、コレクションで編集されたレコードを含むObservableArray を取得します。
trackChanges が有効化されてから、コレクションから削除されたレコードを含むObservableArray を取得します。
コレクションの新しい項目を作成する関数を取得または設定します。
作成関数が提供されない場合、CollectionView は、適切な型の項目を 初期化せずに作成しようとします。
作成関数が提供される場合、その関数は、パラメータを受け取らず、 コレクションに対して適切な型のオブジェクトを初期化して返す 必要があります。
総ページ数を取得します。
現在のページの0から始まるインデックスを取得します。
各ページに表示する項目数を取得または設定します。
このプロパティのデフォルト値は zero です。この場合、ページングが無効になります。
データの取得に使用されるFirestore クライアントライブラリの Query オブジェクトを取得または設定します。
指定する場合、クエリはこの Snapshot の作成に使用された {@link collection} に基づきます。
このプロパティを使用して、ソースnoコレクションから取得するデータを定義します。 フィルタ、データ制限、および並べ替えを適用できます。
たとえば、次のサンプルコードでは、Snapshot が「日本料理店」または「フレンチレ ストラン」種類のレストランを返します。
// スナップショットを作成します
const db = firebase.firestore();
const restaurants = db.collection('restaurants');
const snapshot = new Snapshot(restaurants, {
query: restaurants.where('種類', 'in', ['日本料理', 'フレンチレストラン' ])
});
CollectionView が、アイテムの編集後に結果(ソート、フィルター、およびグループ化を適用する)を自動的に更新するかどうかを決定する値を取得または設定します。
このプロパティはデフォルトで true に設定されます。これにより、 編集が完了した後にコレクションが常に正しくソート、フィルタリング、およびグループ化されるようにします。
false に設定する場合、アイテムの編集時に更新を遅延されます。 この場合、ソート、フィルタリング、およびグループ化の基準が変更されるか、 またはExcelと同様にrefresh メソッドが呼び出されるまで、コレクションは更新されません。
ソート時に値の比較に使用する関数を取得または設定します。
指定された場合、ソート比較関数は、パラメータとして任意の型の値を 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; // 文字列以外にはデフォルトの比較子を使用します
}
});
ソート時の値の変換に使用される関数を取得または設定します。
指定されている場合、この関数は、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;
}
コレクションの項目をビューでどのようにソートするかを記述するSortDescription オブジェクトの配列を取得します。
null値のソート方法を決定する値を取得または設定します。
このプロパティはデフォルトでSortNulls.Lastに設定されます。これにより、コレクションをソートすると、並べ替えの方向に関係なくNULL値が最後に表示されます。 この動作はExcelと同じです。
基になる(フィルタリングもソートもされていない)コレクションを取得または設定します。
ページングを適用する前のビュー内の項目の合計数を取得します。
コントロールがデータの変更を追跡するかどうかを決定する値を取得または設定します。
このプロパティのデフォルト値はfalseに設定されているため、
CollectionViewはどのデータ項目が変更されたかを追跡しません。 このプロパティがtrueに設定されている場合、CollectionView は、
データの変更を追跡し、itemsAdded、itemsRemoved、 itemsEdited の 各コレクションを介して変更を公開します。 変更の追跡は、変更が有効であることをユーザーが確認した後にサーバーを 更新する必要がある場合に役立ちます。
変更をコミットまたはキャンセルしたら、clearChanges メソッドを使用して、
itemsAdded、itemsRemoved、itemsEdited の各コレクションをクリアします。
CollectionView は、適切なCollectionView メソッド(editItem /commitEdit、 addNew /commitNew、remove)を使用して行われた変更だけを追跡します。
データに直接行われた変更は追跡されません。
安定したソートアルゴリズムを使用するかどうかを取得または設定します。
安定したソートアルゴリズムは、同じキーを持つレコード間の相対的な順序を維持します。 たとえば、「Amount」フィールドを持つオブジェクトのコレクションを考えてみます。 このコレクションを「Amount」でソートする場合、安定したソートでは、 Amount値が同じレコード間で元の順序が保たれます。
このプロパティのデフォルトは false です。この場合は、 高速だが安定ではないJavaScriptの組み込みソートメソッドが CollectionView で使用されます。
useStableSort をtrueに設定すると、すべてのブラウザーで安定したソートが保証されますが、ソート時間が30%~50%も長くなります。
注意:Chromeはバージョン70以降、Firefoxバージョン3以降は安定したソートを提供します。 ES2019の場合 、ソートは安定している必要があります。 ES2018までのECMAScript第1版では、不安定になることが許可されていました。
useStableSortプロパティをtrueに設定すると、すべてのブラウザー(IE11も含む)で安定したソートが保証されますが、ソートにかかる時間が30%~50%増加します。
コレクションに新しい項目を追加します。
このメソッドをパラメータなしで呼び出すと、新しい項目が作成されてコレクションに追加され、 commitNewメソッドで新しい項目がコミットされるか、 cancelNewメソッドでキャンセルされるまで、リフレッシュ操作が保留されます。
次のコードは、addNew メソッドの典型的な使用方法を示します。
// 新しい項目を作成し、それをコレクションに追加します
var newItem = view.addNew();
// 新しい項目を初期化します
newItem.id = getFreshId();
newItem.name = '新しい顧客';
// ビューをリフレッシュできるように新しい項目をコミットします
view.commitNew();
新しい項目をsourceCollection にプッシュしてから、refresh メソッドを呼び出すことで、 新しい項目を追加することもできます。addNew では、 ユーザーが追加操作をキャンセルできるため、ユーザー対話式のシナリオ(データグリッドに新しい項目の追加するなど)で特に便利です。 また、追加操作がコミットされるまで、新しい項目がソートされたり、 フィルタ処理でビューから除外されないようにします。
コレクションに calculatedFields がない限り、新しい項目はデフォルトで空のオブジェクトです。 この場合、新しい項目のプロパティは、データ型に応じた値に設定されます(文字列型プロパティの場合は空の文字列、数値型プロパティの場合はゼロ、その他のデータ型の場合はnull)。
多くの場合、計算フィールドは文字列がnullでないことに依存する式に依存するため、 この動作は便利です。ただし、newItemCreatorプロパティを、 新しい項目を作成して初期化する関数に設定することで、 この動作をカスタマイズできます。
コレクションに追加する項目(オプション)。
新しい項目をすぐにコミットするかどうか。
現在の追加トランザクションを終了し、追加前の新しい項目を保存します。
次にendUpdate が呼び出されるまで更新を中断します。
サーバーにコミットせずに、itemsAdded 、itemsRemoved 、itemsEdited の各コレクションの全項目をクリアすることによってすべての変更をキャンセルします。
このメソッドは、deferCommitsプロパティと共に使用されます。
現在の編集トランザクションを終了し、可能であれば項目を元の値に戻します。
現在の追加トランザクションを終了し、追加前の新しい項目を破棄します。
itemsAdded 、itemsRemoved 、itemsEdited の各コレクションの全項目をクリアすることによってすべての変更をクリアします。
このメソッドは、変更をサーバーに確定した後またはデータをサーバーから更新した後に呼び出します。
すべての保留中の変更をサーバーにコミットします。
変更はitemsEdited、itemsAdded、およびitemsRemovedコレクションに含まれており、コミットされると自動的にクリアされます。
deferCommits プロパティも参考してください。
commitNew をオーバーライドして、データベース内の項目を変更します。
commitNew をオーバーライドして、データベースに新しい項目を追加します。
指定した項目がこのビューに属するかどうかを示す値を返します。
調べる項目。
beginUpdate/endUpdate ブロック内で関数を実行します。
この関数が終了するまでコレクションはリフレッシュされません。 deferUpdateメソッドは、update関数が例外を生成した場合でもendUpdate が呼び出されるようにします。
更新なしで実行する関数。
更新の終了時に強制的に更新するかどうか。
指定した項目の編集トランザクションを開始します。
編集する項目。
beginUpdate の呼び出しによって中断された更新を再開します。
更新の終了時に強制的に更新するかどうか。
このコレクション内の項目の集計値を計算します。
計算する集計のタイプ。
集計するプロパティ。
現在のページの項目だけを含めるかどうか。
集計値。
このオブジェクトが指定したインタフェースをサポートしている場合、trueを返します。
調べるインタフェースの名前。
コレクションのデータをロードまたは再ロードします。
カーソル位置を維持したままにするかリセットするかどうか。
指定した項目をビューの現在の項目に設定します。
現在の項目として設定する項目。
ビューの最初の項目を現在の項目として設定します。
ビューの最後の項目を現在の項目として設定します。
ビューの現在の項目の後の項目を現在の項目として設定します。
ビューの指定したインデックスにある項目を現在の項目として設定します。
現在の項目として設定する項目のインデックス。
ビューの現在の項目の前の項目を現在の項目として設定します。
最初のページを現在のページとして設定します。
ページのインデックスが正常に変更された場合はTrue。
最後のページを現在のページとして設定します。
ページのインデックスが正常に変更された場合はTrue。
現在のページの後のページに移動します。
ページのインデックスが正常に変更された場合はTrue。
指定したインデックスにあるページに移動します。
移動先ページのインデックス。
ページのインデックスが正常に変更された場合はTrue。
現在のページの前のページに移動します。
ページのインデックスが正常に変更された場合はTrue。
collectionChanged イベントを発生させます。
変更の記述が含まれます。
currentChanged イベントを発生させます。
currentChanging イベントを発生させます。
イベントデータを含むCancelEventArgs 。
error イベントを発生させます。
error イベントを発生させます。 デフォルトでは、エラーによって例外が生成され、データのリフレッシュがトリガされます。 この動作を回避するには、イベントハンドラでFirestoreErrorEventArgs.cancel パラメータをtrueに設定します。
エラーに関する情報を含むFirestoreErrorEventArgs 。
hasPendingChangesChanged イベントを発生させます。
loading イベントを発生させます。
pageChanged イベントを発生させます。
pageChanging イベントを発生させます。
イベントデータを含むPageChangingEventArgs 。
sourceCollectionChanged イベントを発生させます。
sourceCollectionChanging イベントを発生させます。
イベントデータを含むCancelEventArgs 。
現在のソート、フィルタ、およびグループパラメーターを使用してビューを再作成します。
commitNew をオーバーライドして、データベースから項目を削除します。
データベースから削除する項目。
指定したインデックスにある項目をコレクションから削除します。
コレクションから削除する項目のインデックス。このインデックスは、ソースコレクションに対してではなくビューに対する相対インデックスです。
コレクションが変更されたときに発生します。
現在の項目が変更された後に発生します。
現在の項目が変更される前に発生します。
データの読み込みまたは書き込みエラーがあるときに発生します。
hasPendingChanges プロパティの値が変更されたときに発生します。
deferCommitsプロパティも参考してください。
Snapshot がデータのロードを完了したときに発生します。
Snapshot がデータのロードを開始するときに発生します。
ページインデックスが変更された後に発生します。
ページインデックスが変更される前に発生します。
sourceCollection プロパティの値が変化した後に発生します。
sourceCollection プロパティの値が変化する前に発生します。
CollectionView クラスを拡張して、Firestoreコレクションへのアクセスを提供します。
Snapshotクラスは、リアルタイムの更新を提供することに加えて、Collectionクラスが提供するものと同様の機能を提供します。
他のアプリケーションがデータを変更する場合、Snapshotが自動的に更新されます。
このクラスでは、Firestoreクライアントライブラリを使用する必要があります。 ライブラリをプロジェクトに追加する方法については、「https://firebase.google.com/docs/web/setup」を参照してください。
OAuth2 コンポーネントを使用してトークンを取得し、 アプリケーションが Firestore クライアントライブラリを使用することを承認できます。
たとえば、「auth」というOAuth2コンポーネントがある場合は、次のようにuserChangedイベントを使用してトークンを適用できます。
// ユーザーが変更したときに資格情報を更新します auth.userChanged.addHandler(s => { let user = auth.user; oAuthBtn.textContent = user ? 'Sign Out' : 'Sign In'; let credential = firebase.auth.GoogleAuthProvider.credential(auth.idToken); firebase.auth().signInWithCredential(credential) .then(() => console.log('logged in ok')) .catch(error => console.log('log in failed:', error)); }); Firebase認証の詳細については、「https://firebase.google.com/docs/auth/web/google-signin」を参照してください。