Wijmo_Olap.Pivotfieldcollection

PivotFieldCollection クラス

PivotField オブジェクトのコレクションを表します。

階層

ObservableArray<PivotField>
- PivotFieldCollection

コンストラクタ

constructor

プロパティ

メソッド

イベント

collectionChanged

コンストラクタ

constructor

new PivotFieldCollection(engine: PivotEngine): PivotFieldCollection

オーバーライド ObservableArray.constructor

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

引数
- engine: PivotEngine
  
  このPivotFieldCollection を所有するPivotEngine。
戻り値 PivotFieldCollection

プロパティ

engine

engine: PivotEngine

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

isUpdating

isUpdating: boolean

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

length

length: number

配列の長さを取得または設定します。これは、配列で定義された最も高い要素より1つ大きい値です。

maxItems

maxItems: number

このコレクションで許容されるフィールドの最大数を取得または設定します。

デフォルトでは、このプロパティはnullに設定されます。この場合、任意の数の項目が許容されます。

メソッド

at

at(index: number): PivotField | undefined

継承元 RelativeIndexable.at

整数値を取り、そのインデックスにある項目を返します。正と負の整数が許可されます。負の整数は、配列の最後の項目からカウントされます。

引数
- index: number
戻り値 PivotField | undefined

beginUpdate

beginUpdate(): void

継承元 ObservableArray.beginUpdate

次にendUpdate が呼び出されるまで通知を中断します。

戻り値 void

clear

clear(): void

継承元 ObservableArray.clear

配列からすべての項目を削除します。

戻り値 void

concat

concat(...items: ConcatArray<PivotField>[]): PivotField[]
concat(...items: (T | ConcatArray<T>)[]): PivotField[]

継承元 Array.concat

2つ以上の配列を結合します。

引数
- Rest ...items: ConcatArray<PivotField>[]
  
  array1の末尾に追加する追加項目。
戻り値 PivotField[]
継承元 Array.concat

2つ以上の配列を結合します。

引数
- Rest ...items: (T | ConcatArray<T>)[]
  
  array1の末尾に追加する追加項目。
戻り値 PivotField[]

deferUpdate

deferUpdate(fn: Function): void

継承元 ObservableArray.deferUpdate

beginUpdate/endUpdate ブロック内で関数を実行します。

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

引数
- fn: Function
  
  更新なしで実行する関数。
戻り値 void

endUpdate

endUpdate(): void

継承元 ObservableArray.endUpdate

beginUpdate の呼び出しによって中断された通知を再開します。

戻り値 void

entries

entries(): IterableIterator<[number, PivotField]>

継承元 Array.entries

配列の各要素のキーと値のペアを持つ反復可能オブジェクトを返します。

戻り値 IterableIterator<[number, PivotField]>

every

every(callbackfn: Object, thisArg?: any): boolean

継承元 Array.every

配列内のすべての要素が指定されたテストに合格するかどうかテストを実行します。

引数
- callbackfn: Object
  
  引数を 3 つまで受け取る関数。 every メソッドは、array1 の各要素に対して、callbackfn が false を返すか、または配列の末尾に到達するまで callbackfn 関数を呼び出します。
- オプション thisArg: any
  
  this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。
戻り値 boolean

filter

filter<S>(callbackfn: Object, thisArg?: any): S[]
filter(callbackfn: Object, thisArg?: any): PivotField[]

継承元 Array.filter

コールバック関数で指定された条件を満たす配列の要素を返します。

Type parameters
- S: PivotField
引数
- callbackfn: Object
  
  引数を 3 つまで受け取る関数。 filter メソッドは、配列内の各要素に対して callbackfn 関数を 1 回呼び出します。
- オプション thisArg: any
  
  this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。
戻り値 S[]
継承元 Array.filter

コールバック関数で指定された条件を満たす配列の要素を返します。

引数
- callbackfn: Object
  
  引数を 3 つまで受け取る関数。 filter メソッドは、配列内の各要素に対して callbackfn 関数を 1 回呼び出します。
- オプション thisArg: any
  
  this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。
戻り値 PivotField[]

forEach

forEach(callbackfn: Object, thisArg?: any): void

継承元 Array.forEach

配列内の各要素に対して指定されたアクションを実行します。

引数
- callbackfn: Object
  
  引数を 3 つまで受け取る関数。 forEach メソッドは、配列内の各要素に対して callbackfn 関数を 1 回呼び出します。
- オプション thisArg: any
  
  this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。
戻り値 void

getField

getField(key: string): PivotField

キーに基づいてフィールドを取得します。

引数
- key: string
  
  検索する PivotField.key。
戻り値 PivotField

implementsInterface

implementsInterface(interfaceName: string): boolean

継承元 ObservableArray.implementsInterface

指定したインタフェースがサポートされている場合、trueを返します。

引数
- interfaceName: string
  
  調べるインタフェースの名前。
戻り値 boolean

指定したインタフェースがサポートされている場合はtrue。

indexOf

indexOf(searchElement: PivotField, fromIndex?: number): number

継承元 ObservableArray.indexOf

オーバーライド Array.indexOf

配列内で項目を検索します。

引数
- searchElement: PivotField
  
  配列内で検索する要素。
- オプション fromIndex: number
  
  検索を開始するインデックス。
戻り値 number

配列内の項目のインデックス。項目が見つからない場合は-1。

insert

insert(index: number, item: PivotField): void

継承元 ObservableArray.insert

配列内の指定した位置に項目を挿入します。

引数
- index: number
  
  項目を追加する位置。
- item: PivotField
  
  配列に追加する項目。
戻り値 void

join

join(separator?: string): string

継承元 Array.join

指定されたセパレータによって分離された配列のすべての要素を追加します。

引数
- オプション separator: string
  
  返された文字列内で配列の要素を次の要素から分離するために使用される文字列。引数を省略すると、配列要素はコンマで区切られます。
戻り値 string

keys

keys(): IterableIterator<number>

継承元 Array.keys

配列内のキーを持つ反復可能オブジェクトを返します。

戻り値 IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: PivotField, fromIndex?: number): number

継承元 Array.lastIndexOf

配列内で指定された値が最後に見つかった位置のインデックスを返します。

引数
- searchElement: PivotField
  
  配列内で検索する値。
- オプション fromIndex: number
  
  検索を開始する配列インデックス。 fromIndexを省略すると、検索は配列の最後のインデックスから開始されます。
戻り値 number

map

map<U>(callbackfn: Object, thisArg?: any): U[]

継承元 Array.map

定義されたコールバック関数を配列の各要素に対して呼び出し、結果を含む配列を返します。

Type parameters
- U
引数
- callbackfn: Object
  
  引数を 3 つまで受け取る関数。 map メソッドは、配列内の各要素に対して callbackfn 関数を 1 回呼び出します。
- オプション thisArg: any
  
  this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。
戻り値 U[]

onCollectionChanged

onCollectionChanged(e?: NotifyCollectionChangedEventArgs<any>): void

継承元 ObservableArray.onCollectionChanged

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

引数
- オプション e: NotifyCollectionChangedEventArgs<any>
  
  変更の記述が含まれます。
戻り値 void

push

push(...item: any[]): number

オーバーライド ObservableArray.push

ヘッダーに基づいてフィールドをプッシュできるようにオーバーライドされます。

引数
- Rest ...item: any[]
戻り値 number

配列の新しい長さ。

remove

remove(item: PivotField): boolean

継承元 ObservableArray.remove

配列から項目を削除します。

引数
- item: PivotField
  
  削除する項目。
戻り値 boolean

項目が削除された場合はtrue、配列に見つからない場合はfalse。

removeAt

removeAt(index: number): void

継承元 ObservableArray.removeAt

配列内の指定した位置にある項目を削除します。

引数
- index: number
  
  削除する項目の位置。
戻り値 void

reverse

reverse(): PivotField[]

継承元 Array.reverse

配列の要素の順番を反転させます。

戻り値 PivotField[]

setAt

setAt(index: number, item: PivotField): void

継承元 ObservableArray.setAt

配列内の指定した位置にある項目を設定します。

引数
- index: number
  
  項目を設定する位置。
- item: PivotField
  
  配列に設定する項目。
戻り値 void

shift

shift(): PivotField

継承元 ObservableArray.shift

オーバーライド Array.shift

配列から最初の要素を取り除き、その要素を返します。

このメソッドは、配列の長さを変更します。

戻り値 PivotField

slice

slice(begin?: number, end?: number): PivotField[]

継承元 ObservableArray.slice

オーバーライド Array.slice

配列の一部のシャローコピーを作成します。

引数
- オプション begin: number
  
  コピーを開始する位置。
- オプション end: number
  
  コピーを終了する位置。
戻り値 PivotField[]

配列の一部のシャローコピー。

some

some(callbackfn: Object, thisArg?: any): boolean

継承元 Array.some

指定されたコールバック関数が配列ののいずれかの要素に対して true を返すかどうかを決定します。

引数
- callbackfn: Object
  
  引数を 3 つまで受け取る関数。 some メソッドは、array1 の各要素に対して、callbackfn が trueを返すか、または配列の末尾に到達するまで callbackfn 関数を呼び出します。
- オプション thisArg: any
  
  this のキーワードが callbackfn 関数内で参照できるオブジェクト。 thisArg を省略すると、undefined が this 値として使用されます。
戻り値 boolean

sort

sort(compareFn?: Function): this

継承元 ObservableArray.sort

オーバーライド Array.sort

配列の要素を適切な位置にソートします。

引数
- オプション compareFn: Function
  
  ソート順序を定義する関数を指定します。この関数は2つの引数を受け取り、 -1（最初の引数の方が2番目の引数より小さい場合）、+1（大きい場合）、0（等しい場合）のいずれかの値を返す必要があります。これを省略した場合は、各要素の文字列変換に従って辞書順にソートされます。
戻り値 this

ソートされた配列のコピー。

splice

splice(index: number, count: number, ...item: PivotField[]): PivotField[]

継承元 ObservableArray.splice

オーバーライド Array.splice

配列からの項目の削除と配列への項目の追加の一方または両方を行います。

引数
- index: number
  
  項目を追加または削除する位置。
- count: number
  
  配列から削除する項目の数。
- Rest ...item: PivotField[]
戻り値 PivotField[]

削除された要素を含む配列。

toLocaleString

toLocaleString(): string

継承元 Array.toLocaleString

配列の文字列表現を返します。要素は、toLocalStringメソッドを使用して文字列に変換されます。

戻り値 string

toString

toString(): string

継承元 Array.toString

配列の文字列表現を返します。

戻り値 string

unshift

unshift(...items: PivotField[]): number

継承元 ObservableArray.unshift

オーバーライド Array.unshift

配列の最初に1つ以上の要素を追加し、配列の新しい長さを返します。

引数
- Rest ...items: PivotField[]
戻り値 number

配列の新しい長さ。

values

values(): IterableIterator<PivotField>

継承元 Array.values

配列内の値を持つ反復可能オブジェクトを返します。

戻り値 IterableIterator<PivotField>

イベント

collectionChanged

collectionChanged: Event<ObservableArray<PivotField>, NotifyCollectionChangedEventArgs<PivotField>>

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

Wijmo_Olap.Pivotfieldcollection

PivotFieldCollection クラス

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

引数

engine: PivotEngine

戻り値 PivotFieldCollection

プロパティ

engine

isUpdating

length

maxItems

メソッド

at

引数

index: number

戻り値 PivotField | undefined

beginUpdate

戻り値 void

clear

戻り値 void

concat

引数

Rest ...items: ConcatArray<PivotField>[]

戻り値 PivotField[]

引数

Rest ...items: (T | ConcatArray<T>)[]

戻り値 PivotField[]

deferUpdate

引数

fn: Function

戻り値 void

endUpdate

戻り値 void

entries

戻り値 IterableIterator<[number, PivotField]>

every

引数

callbackfn: Object

オプション thisArg: any

戻り値 boolean

filter

Type parameters

S: PivotField

引数

callbackfn: Object

オプション thisArg: any

戻り値 S[]

引数

callbackfn: Object

オプション thisArg: any

戻り値 PivotField[]

forEach

引数

callbackfn: Object

オプション thisArg: any

戻り値 void

getField

引数

key: string

戻り値 PivotField

implementsInterface

引数

interfaceName: string

戻り値 boolean

indexOf

引数

searchElement: PivotField

オプション fromIndex: number

戻り値 number

insert

引数

index: number

item: PivotField

戻り値 void