5.20201.663
CubePivotField Wijmo API クラス

CubePivotField クラス

PivotField クラスを拡張して、サーバーベースのキューブデータソース内の フィールドを表します。

階層

コンストラクタ

constructor

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

    引数

    • engine: PivotEngine

      このフィールドを所有する PivotEngine

    • binding: string

      このフィールドの連結先のプロパティ。

    • オプション header: string

      このフィールドを識別するために表示されるヘッダー(デフォルトは連結先と同じ)。

    • オプション options: any

      フィールドの初期化データを含むJavaScriptオブジェクト。

    戻り値 CubePivotField

プロパティ

aggregate

aggregate: Aggregate

フィールドの集計方法を取得または設定します。

このプロパティのデフォルト値は、数値フィールドの場合は Aggregate.Sum、その他のフィールドタイプの場合は Aggregate.Count です。

align

align: string

このフィールドのセルの水平方向の配置を取得または設定します。

このプロパティのデフォルト値はnullで、 フィールドのdataType に基づいて配置が自動的に選択されます (数値の場合は右揃え、ブール値の場合は中央揃え、その他の型の場合は左揃え)。

デフォルトの配置をオーバーライドする場合は、 このプロパティを'left'、'right'、'center'、'justify'のいずれかに設定します。

binding

binding: string

フィールドの連結先のプロパティの名前を取得または設定します。

collectionView

collectionView: ICollectionView

このフィールドに連結されたICollectionView を取得します。

dataType

dataType: DataType

フィールドのデータ型を取得または設定します。

descending

descending: boolean

このフィールドのキーを降順でソートするかどうかを決定する値を取得または設定します。

このプロパティのデフォルト値はfalse です。

dimensionType

dimensionType: DimensionType

フィールドのディメンションタイプを取得または設定します。

engine

engine: PivotEngine

このPivotField を所有するPivotEngine への参照を取得します。

filter

filter: PivotFilter

このフィールドの値をフィルタ処理するために使用されるPivotFilter への参照を取得します。

キューブデータソースでのメジャーフィールドの場合、フィルターは集計セル値に適用されます。 ノンキューブデータソースでのメジャーフィールドの場合、フィルターは生データに適用されます。

format

format: string

フィールド値の表示に使用する書式を取得または設定します。

このプロパティのデフォルト値は、日付フィールドの場合は 'd'、 数値フィールドの場合は 'n0'、その他のフィールドタイプの場合は空の文字列です。

getValue

getValue: Function

フィールドの値を取得するために使用される関数を取得または設定します。

このプロパティはデフォルトではnullに設定されます。 これにより、 計算エンジンがフィールドの binding プロパティを使用して値を取得します。

指定された場合、関数は評価されるデータ項目を表す単一のパラメータをとり、 その項目の計算された値を返す必要があります。

Example

header

header: string

ユーザーインタフェースでこのフィールドを表すために使用される文字列を取得または設定します。

isActive

isActive: boolean

このフィールドが現在ビューで使用されているかどうかを判定する値を 取得または設定します。

このプロパティをtrueに設定すると、フィールドのデータ型に応じて ビューのPivotEngine.rowFields またはPivotEngine.valueFields に フィールドが追加されます。

isContentHtml

isContentHtml: boolean

このフィールドの項目がプレーンテキストではなく、HTMLコンテンツを 含むかどうかを示す値を取得または設定します。

このプロパティのデフォルト値はfalse です。

isMeasure

isMeasure: boolean

ディメンションの種類を考慮してオーバーライドされます。

key

key: string

このCubePivotField のキーを取得します。

このタイプのフィールドの場合、キーはフィールドのbinding です。

parentField

parentField: PivotField

フィールドの親フィールドを取得します。

同じフィールドを[値]リストに複数回ドラッグすると、 フィールドのコピーが作成され、同じ連結を異なるパラメータで使用できます。コピーは、 その親フィールドへの参照を保持します。

showAs

showAs: ShowAs

集計値の表示方法を指定する値を取得または設定します。

このプロパティのオプションは ShowAs 列挙型によって定義され、 値と前の行または列の値の差、行、列、総計、および積算合計に対するパーセンテージ が含まれます。

このプロパティは、Excelの 値として表示に似ています。

このプロパティのデフォルト値はShowAs.NoCalculationです。

sortComparer

sortComparer: Function

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

指定された場合、ソート比較関数は、パラメータとして任意の型の値を 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);
    }
  }
});

subFields

subFields: PivotField[]

このフィールドの子フィールドを取得します。

visible

visible: boolean

このフィールドを PivotPanel コントロールのインスタンスに 表示するかどうかを示す値を取得または設定します。

このプロパティのデフォルト値は true です。

このプロパティがfalseに設定された場合は、 PivotPanel コントロールに表示できるすべてのフィールドが非表示になり、 ユーザーがエンジンのビュー定義内のフィールド位置を追加、削除、または変更できなくなります。

weightField

weightField: PivotField

このフィールドの集計の計算時に重みとして使用するPivotField を 取得または設定します。

このプロパティがnullに設定されている場合は、すべての値が重み1と見なされます。

このプロパティを使用すると、加重平均や加重合計を計算できます。 たとえば、データに'Quantity'フィールドと'Price'フィールドがある場合に、 'Price' フィールドを値フィールドとして使用し、'Quantity'フィールドを 重みとして使用できます。出力には、データの加重平均が含まれます。

width

width: number

このフィールドを PivotGrid などのユーザーインタフェースに表示するために使用する適切な幅を取得または設定します。

wordWrap

wordWrap: boolean

このフィールドのコンテンツをセル内で折り返すことができるかどうかを示す値を 取得または設定します。

このプロパティのデフォルト値はfalse です。

メソッド

onPropertyChanged

イベント

propertyChanged

このRange のプロパティ値が変更されると発生します。