クラス: GeneralSlicerData

Spread.Slicers.GeneralSlicerData

Hierarchy

• GeneralSlicerData

  ↳ TableSlicerData

Table of contents

コンストラクタ

• constructor

プロパティ

• columnNames
• data

メソッド

• aggregateData
• attachListener
• clearPreview
• detachListener
• doFilter
• doUnfilter
• getColumnIndex
• getData
• getExclusiveData
• getExclusiveRowIndex
• getFilteredIndexes
• getFilteredOutIndexes
• getFilteredOutRanges
• getFilteredOutRowIndexes
• getFilteredRanges
• getFilteredRowIndexes
• getRowIndexes
• inPreview
• onColumnNameChanged
• onColumnsRemoved
• onDataChanged
• onFiltered
• onRowsAdded
• onRowsRemoved
• resumeFilteredEvents
• suspendFilteredEvents

コンストラクタ

constructor

• new GeneralSlicerData(data, columnNames)

一般的なスライサーのデータを表します。

パラメータ

名前	型	説明
data	any[][]	スライサーデータ。これは行列の配列です。
columnNames	string[]	スライサーデータの列名。

プロパティ

columnNames

• columnNames: string[]

一般スライサーデータの列名を示します。

---

data

• data: any[][]

一般スライサーデータのデータソースを示します。

メソッド

aggregateData

▸ aggregateData(columnName, aggregateType, range?): number

指定した列名によってデータを集計します。

パラメータ

名前	型	説明
columnName	string	列名。
aggregateType	SlicerAggregateType	集計タイプ。
range?	ISlicerRangeConditional	指定した範囲。range.min: number型、最小値。range.max: number型、最大値。

戻り値

number

集計されたデータ。

---

attachListener

▸ attachListener(listener): void

リスナーをアタッチします。

パラメータ

名前	型	説明
listener	ISlicerListener	リスナー。

戻り値

void

---

clearPreview

▸ clearPreview(): void

プレビューフィルタ状態をクリアします。

戻り値

void

---

detachListener

▸ detachListener(listener): void

リスナーをデタッチします。

パラメータ

名前	型	説明
listener	ISlicerListener	リスナー。

戻り値

void

---

doFilter

▸ doFilter(columnName, conditional, isPreview?): void

指定した列名と排他的データのインデックスに対応するデータをフィルタします。

パラメータ

名前	型	説明
columnName	string	列名。
conditional	ISlicerConditional	条件フィルタ。conditional.exclusiveRowIndexes: number array型、表示可能な排他的行インデックス。conditional.ranges: {min:number, max:number} array型、表示可能な範囲。
isPreview?	boolean	プレビューが設定されているかどうかを示します。

戻り値

void

---

doUnfilter

▸ doUnfilter(columnName): void

指定した列名に対応するデータをフィルタ解除します。

パラメータ

名前	型	説明
columnName	string	列名。

戻り値

void

---

getColumnIndex

▸ getColumnIndex(columnName): number

指定した列名によって列インデックスを取得します。

パラメータ

名前	型	説明
columnName	string	列名。

戻り値

number

列インデックス。

---

getData

▸ getData(columnName, range?): string[]

指定した列名によってデータを取得します。

パラメータ

名前	型	説明
columnName	string	列名。
range?	ISlicerRangeConditional	指定した範囲。range.min: number型、最小値。range.max: number型、最大値。

戻り値

string[]

指定した列名に対応するデータ。

---

getExclusiveData

▸ getExclusiveData(columnName): any[]

指定した列名によって排他的データを取得します。

パラメータ

名前	型	説明
columnName	string	列名。

戻り値

any[]

指定した列名に対応する排他的データ。

---

getExclusiveRowIndex

▸ getExclusiveRowIndex(columnName, rowIndex): number

指定した列名とデータインデックスによって排他的データのインデックスを取得します。

パラメータ

名前	型	説明
columnName	string	列名。
rowIndex	number	データのインデックス。

戻り値

number

指定した列名とデータインデックスに対応する排他的データのインデックス。

---

getFilteredIndexes

▸ getFilteredIndexes(columnName): number[]

指定した列名によってフィルタされた排他的データのインデックスを取得します。

パラメータ

名前	型	説明
columnName	string	列名。

戻り値

number[]

指定した列名に対応するフィルタされた排他的データのインデックス。

---

getFilteredOutIndexes

▸ getFilteredOutIndexes(columnName, filteredOutDataType): number[]

指定した列名によってフィルタアウトされた排他的データのインデックスを取得します。

パラメータ

名前	型	説明
columnName	string	列名。
filteredOutDataType	FilteredOutDataType	結果に含める、フィルタアウトされた排他的データのインデックスの種類を示します。

戻り値

number[]

指定した列名に対応するフィルタアウトされた排他的データのインデックス。

---

getFilteredOutRanges

▸ getFilteredOutRanges(columnName): ISlicerRangeConditional[]

他の列によってフィルタアウトされた範囲を取得します。

パラメータ

名前	型	説明
columnName	string	列名。

戻り値

ISlicerRangeConditional[]

指定した列名に対応する、他の列によってフィルタアウトされた範囲。

---

getFilteredOutRowIndexes

▸ getFilteredOutRowIndexes(): number[]

フィルタアウトされた行のインデックスを取得します。

戻り値

number[]

フィルタアウトされた行のインデックス。

---

getFilteredRanges

▸ getFilteredRanges(columnName): ISlicerRangeConditional[]

指定した列名によってフィルタされた範囲を取得します。

パラメータ

名前	型	説明
columnName	string	列名。

戻り値

ISlicerRangeConditional[]

指定した列名に対応するフィルタされた範囲。

---

getFilteredRowIndexes

▸ getFilteredRowIndexes(): number[]

フィルタされた行のインデックスを取得します。

戻り値

number[]

フィルタされた行のインデックス。

---

getRowIndexes

▸ getRowIndexes(columnName, exclusiveRowIndex): number[]

指定した列名と排他的データのインデックスによってデータインデックスを取得します。

パラメータ

名前	型	説明
columnName	string	列名。
exclusiveRowIndex	number	排他的データのインデックス。

戻り値

number[]

指定した列名と排他的データのインデックスに対応するデータインデックス。

---

inPreview

▸ inPreview(): boolean

スライサーがプレビュー状態にあるかどうかを取得します。

戻り値

boolean

---

onColumnNameChanged

▸ onColumnNameChanged(oldName, newName): void

一般スライサーデータの列名を変更します。

パラメータ

名前	型	説明
oldName	string	列の古い名前。
newName	string	列の新しい名前。

戻り値

void

---

onColumnsRemoved

▸ onColumnsRemoved(colIndex, colCount): void

一般スライサーデータの列を削除します。

パラメータ

名前	型	説明
colIndex	number	開始列のインデックス。
colCount	number	削除する列数。

戻り値

void

---

onDataChanged

▸ onDataChanged(changedDataItems): void

一般スライサーデータのデータソースに含まれるデータアイテムを変更します。

パラメータ

名前	型
changedDataItems	ISlicerDataItem

戻り値

void

---

onFiltered

▸ onFiltered(): void

スライサーデータがフィルタされた後に発生します。

戻り値

void

---

onRowsAdded

▸ onRowsAdded(rowIndex, rowCount): void

一般スライサーデータのデータソースに行を追加します。

パラメータ

名前	型	説明
rowIndex	number	開始行のインデックス。
rowCount	number	追加する行数。

戻り値

void

---

onRowsRemoved

▸ onRowsRemoved(rowIndex, rowCount): void

一般スライサーデータのデータソースから行を削除します。

パラメータ

名前	型	説明
rowIndex	number	開始行のインデックス。
rowCount	number	削除する行数。

戻り値

void

---

resumeFilteredEvents

▸ resumeFilteredEvents(): void

onFilteredイベントを再開します。

戻り値

void

---

suspendFilteredEvents

▸ suspendFilteredEvents(): void

onFilteredイベントを中断します。

戻り値

void