constructor(engine: PivotEngine, binding: string, header?: string, options?: any): CubePivotField
CubePivotFieldクラスの新しいインスタンスを初期化します。
PivotEngine that owns this field.
Property that this field is bound to.
Header shown to identify this field (defaults to the binding).
JavaScript object containing initialization data for the field.
フィールドの集計方法を取得または設定します。
このプロパティのデフォルト値は、数値フィールドの場合は **Aggregate.Sum** 、その他のフィールドタイプの場合は **Aggregate.Count**です。
このフィールドのセルの水平方向の配置を取得または設定します。
このプロパティのデフォルト値はnullで、列のdataType に基づいて配置が自動的に選択されます（数値の場合は右揃え、ブール値の場合は中央揃え、その他の型の場合は左揃え）。
デフォルトの配置をオーバーライドする場合は、このプロパティを'left'、'right'、'center'、または'justify’のいずれかに設定します。
このフィールドのキーを降順でソートするかどうかを決定する値を取得または設定します。
このプロパティのデフォルト値は **false**です。
このフィールドの値をフィルタ処理するために使用されるPivotFilter への参照を取得します。
キューブデータソースでのメジャーフィールドの場合、フィルターは集計セル値に適用されます。 ノンキューブデータソースでのメジャーフィールドの場合、フィルターは生データに適用されます。
フィールド値の表示に使用する書式を取得または設定します。
このプロパティのデフォルト値は、日付フィールドの場合は **"d"**、 数値フィールドの場合は **"n0"**、その他のフィールドタイプの場合は空の文字列です。
指定されたサマリーオブジェクトのフィールドの集計値を取得するために使用される関数を取得または設定します。
このプロパティはデフォルトではnullに設定されます。 これにより、 エンジンはフィールドのaggregateプロパティとshowAsプロパティを使用して集計を計算します。
指定された場合、関数は、 エンジンによって生成されたサマリーオブジェクトを表す単一のパラメーターを取り、 項目の集計値を返す必要があります。
getValueプロパティ（未処理のデータ項目を取得して未処理の値を返す関数）と getAggregateValue（サマリーオブジェクトを取得して集計値を返す関数）には 違いがあることに注意してください。
```typescript fields: [ { header: 'サマリー行ごとの変換。', dataType: 'Number', format: 'p0',
// getAggregateValueは、サマリー行（Downloads、Sales）から集計を計算します // **メモ**: この数式は、「Downloads」フィールドと「Sales」フィールドが // PivotEngineのvalueFields配列に存在する場合に機能します。 getAggregateValue: row => row.Downloads ? row.Sales / row.Downloads : 0 }, { header: '未処理のデータ項目ごとの変換。', dataType: 'Number', aggregate: 'Avg', format: 'p0',
// getValueは、データ項目（Downloads、Sales）から未処理の値を計算します getValue: item => item.downloads ? item.sales / item.downloads : 0 }, ```
{@sample OLAP/PivotPanel/Fields/Customize/FieldSettingsDialog/Calculated デモ}
特定のデータ項目のフィールド値を取得するために使用される関数を取得または設定します。
このプロパティはデフォルトではnullに設定されます。 これにより、 計算エンジンがフィールドの binding プロパティを使用して値を取得します。
指定された場合、関数は評価されるデータ項目を表す単一のパラメータをとり、 その項目の計算された値を返す必要があります。
getValueプロパティ（未処理のデータ項目を取得して未処理の値を返す関数）と getAggregateValue（サマリーオブジェクトを取得して集計値を返す関数）には 違いがあることに注意してください。
```typescript fields: [ { header: 'サマリー行ごとの変換。', dataType: 'Number', format: 'p0',
// getAggregateValueは、サマリー行（Downloads、Sales）から集計を計算します getAggregateValue: row => row.Downloads ? row.Sales / row.Downloads : 0 }, { header: 'Conversion (per raw data item)', dataType: 'Number', aggregate: 'Avg', format: 'p0',
// getValueは、データ項目（Downloads、Sales）から未処理の値を計算します getValue: item => item.downloads ? item.sales / item.downloads : 0 }, ```
{@sample OLAP/PivotPanel/Fields/Customize/FieldSettingsDialog/Calculated デモ}
このフィールドが現在ビューで使用されているかどうかを判定する値を取得または設定します。
このプロパティをtrueに設定すると、フィールドのデータ型に応じてビューのrowFields またはvalueFields に フィールドが追加されます。
このフィールドの項目がプレーンテキストではなく、HTMLコンテンツを 含むかどうかを示す値を取得または設定します。
このプロパティのデフォルト値は **false**です。
フィールドの親フィールドを取得します。
同じフィールドを［値］リストに複数回ドラッグすると、 フィールドのコピーが作成され、同じ連結を異なるパラメータで使用できます。コピーは、 その親フィールドへの参照を保持します。
集計値の表示方法を指定する値を取得または設定します。
このプロパティのオプションは ShowAs 列挙型によって定義され、 値と前の行または列の値の差、行、列、総計、および積算合計に対するパーセンテージ が含まれます。
このプロパティは、Excelの Show Values As に似ています。
このプロパティのデフォルト値は**ShowAs.NoCalculation**です。
ソート時に値の比較に使用する関数を取得または設定します。
指定された場合、ソート比較関数は、パラメータとして任意の型の値を 2つ取り、最初の値が2番目の値と比べて小さい、等しい、または大きいのいずれであるかを示す値-1、0、または+1を返します。ソート比較関数がnullを返す場合は、標準の組み込み比較子が使用されます。
この sortComparer プロパティを使用すると、カスタム比較アルゴリズムを提供でき、単純な文字列比較より、ユーザーが期待する結果によく一致するソートシーケンスが得られる場合があります。
次の例は、 sortComparer プロパティの一般的な使用方法を示します。
// 製品のリストを定義します
app.products = 'Wijmo,Aoba,Olap,Xuni'.split(',');
// 'app.products'配列の位置で商品をソートします
ng.viewDefinitionChanged.addHandler(function () {
var fld = ng.fields.getField('Product');
if (fld) {
fld.sortComparer = function (val1, val2) {
return app.products.indexOf(val1) - app.products.indexOf(val2);
}
}
});
このフィールドを PivotPanel コントロールのインスタンスに表示するかどうかを示す値を取得または設定します。
このプロパティのデフォルト値は**true**です。
このプロパティがfalseに設定された場合は、 PivotPanel コントロールに表示できるすべてのフィールドが非表示になり、ユーザーがエンジンのビュー定義内のフィールド位置を追加、削除、または変更できなくなります。
このフィールドの集計の計算時に重みとして使用するPivotField を取得または設定します。
このプロパティがnullに設定されている場合は、すべての値が重み1と見なされます。
このプロパティを使用すると、加重平均や加重合計を計算できます。 たとえば、データに'Quantity'フィールドと'Price'フィールドがある場合に、 'Price' フィールドを値フィールドとして使用し、'Quantity'フィールドを 重みとして使用できます。出力には、データの加重平均が含まれます。
このフィールドのコンテンツをセル内で折り返すことができるかどうかを示す値を取得または設定します。
このプロパティのデフォルト値は **false**です。
onPropertyChanged(e: PropertyChangedEventArgs): void
propertyChangedイベントを発生させます。
PropertyChangedEventArgs that contains the property name, old, and new values.
PivotField クラスを拡張して、サーバーベースのキューブデータソース内のフィールドを表します。