クラス: HideRowFilter

Sheets.Filter.HideRowFilter

Hierarchy

• RowFilterBase

  ↳ HideRowFilter

Table of contents

コンストラクタ

• constructor

プロパティ

• extendedRange
• range
• typeName

メソッド

• addFilterItem
• filter
• filterButtonVisible
• filterDialogVisibleInfo
• fromJSON
• getFilterItems
• getFilteredItems
• getSortState
• isFiltered
• isRowFilteredOut
• onFilter
• openFilterDialog
• removeFilterItems
• reset
• sortColumn
• toJSON
• unfilter

コンストラクタ

constructor

• new HideRowFilter(range?)

デフォルト行フィルタを表します。

実例

// 次のサンプルコードは、新しいフィルタを作成します。
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(0,0,4,4)));
sheet.repaint();

パラメータ

名前	型	説明
range?	Range	フィルタ範囲。

オーバーライド

RowFilterBase.constructor

プロパティ

extendedRange

• extendedRange: Range

行フィルターの拡張範囲を表します。

継承元

RowFilterBase.extendedRange

---

range

• range: Range

行フィルタの範囲を表します。

継承元

RowFilterBase.range

---

typeName

• typeName: string

シリアル化のサポートに使用される型名の文字列を表します。

継承元

RowFilterBase.typeName

メソッド

addFilterItem

▸ addFilterItem(col, condition): void

指定したフィルタを行フィルタに追加します。

パラメータ

名前	型	説明
col	number	列インデックス。
condition	Condition	フィルタリングする条件。

戻り値

void

継承元

RowFilterBase.addFilterItem

---

filter

▸ filter(col?): void

指定した列をフィルタリングします。

パラメータ

名前	型	説明
col?	number	フィルタリングする列のインデックス。これを省略した場合、範囲内のすべての列がフィルタリングされます。

戻り値

void

継承元

RowFilterBase.filter

---

filterButtonVisible

▸ filterButtonVisible(col?, value?): any

シート列のフィルタボタンが表示されるかどうかを取得または設定します。

パラメータ

名前	型	説明
col?	number	フィルタボタンの列インデックス。
value?	boolean	フィルタボタンが表示されるかどうか。

戻り値

any

 パラメーターなし: すべてのフィルタボタンが表示されない場合は<c>false</c>、それ以外の場合は<c>true</c>。
 パラメーター1個（col）: 指定した列のフィルタボタンが表示されない場合は<c>false</c>、それ以外の場合は<c>true</c>。
 パラメーター1個（value）: <c>GC.Spread.Sheets.Filter.RowFilterBase</c>がすべてのフィルタボタンを表示（true）または非表示（false）に設定します。
 パラメーター2個（col、value）: <c>GC.Spread.Sheets.Filter.RowFilterBase</c>が指定した列のフィルタボタンを表示（true）または非表示（false）に設定します。

継承元

RowFilterBase.filterButtonVisible

---

filterDialogVisibleInfo

▸ filterDialogVisibleInfo(visibleInfo?): any

行フィルタの表示/非表示情報を取得または設定します。

実例

// 次のサンプルコードは、行フィルタを作成します。
 sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(1,1,10,3)));
 var filter = sheet.rowFilter();
 filter.filterDialogVisibleInfo({
          sortByValue : false,
          sortByColor : true,
          filterByColor : true,
          filterByValue : true,
          listFilterArea : false
      })

パラメータ

名前	型	説明
visibleInfo?	IFilterDialogVisibleInfo	行フィルタの表示/非表示情報。

戻り値

any

値が設定されていない場合、フィルタダイアログに情報が表示されます。 値が設定されている場合は、HideRowFilterを返します。

---

fromJSON

▸ fromJSON(settings): void

指定したJSON文字列からオブジェクト状態をロードします。

パラメータ

名前	型	説明
settings	Object	逆シリアル化された行フィルタのデータ。

戻り値

void

継承元

RowFilterBase.fromJSON

---

getFilterItems

▸ getFilterItems(col): Condition[]

指定した列のフィルタを取得します。

パラメータ

名前	型	説明
col	number	列インデックス。

戻り値

Condition[]

指定した列に属する条件を含むコレクションを返します。

継承元

RowFilterBase.getFilterItems

---

getFilteredItems

▸ getFilteredItems(): Condition[]

すべての適用済みフィルタ条件を取得します。

戻り値

Condition[]

すべての適用済みフィルタ条件を含むコレクションを返します。

継承元

RowFilterBase.getFilteredItems

---

getSortState

▸ getSortState(col): SortState

現在のソート状態を取得します。

パラメータ

名前	型	説明
col	number	列インデックス。

戻り値

SortState

現在のフィルタのソート状態。

継承元

RowFilterBase.getSortState

---

isFiltered

▸ isFiltered(col?): boolean

行または指定した列がフィルタリングされているかどうかを示す値を取得します。

実例

// 次のサンプルコードは、isFilteredメソッドを使用します。
activeSheet.setValue(0, 0, "North");
activeSheet.setValue(1, 0, "South");
activeSheet.setValue(2, 0, "East");
activeSheet.setValue(3, 0, "South");
activeSheet.setValue(4, 0, "North");
activeSheet.setValue(5, 0, "North");
activeSheet.setValue(6, 0, "West");
activeSheet.setColumnWidth(0, 80);
// 行フィルタを設定します。
activeSheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(0, 0, 7, 1)));
// ボタン
$("#button1").click(function () {
    var rowFilter = spread.getActiveSheet().rowFilter();
    if (rowFilter.isFiltered(0)) {
        alert("Row-filtering executed for Column1");
    } else {
        alert("Row-filtering not executed for Column1");
    }
});
// ボタンコントロールをページを追加します。
<input type="button" id="button1" value="button1"/>

パラメータ

名前	型	説明
col?	number	列インデックス。

戻り値

boolean

パラメーターなし: 一部の行がフィルタリングされている場合はtrue、それ以外の場合はfalse。パラメーター1個（col）: 指定した列がフィルタリングされている場合はtrue、それ以外の場合はfalse。

継承元

RowFilterBase.isFiltered

---

isRowFilteredOut

▸ isRowFilteredOut(row): boolean

指定した行がフィルタに一致していないかどうかを判断します。

パラメータ

名前	型	説明
row	number	行インデックス。

戻り値

boolean

行がフィルタに一致していない場合は<c>true</c>、それ以外の場合は<c>false</c>。

継承元

RowFilterBase.isRowFilteredOut

---

onFilter

▸ onFilter(args): void

列がフィルタリングまたはフィルタリング解除されたときにアクションを実行します。

パラメータ

名前	型	説明
args	IFilteredArgs	<i>action</i>、<i>sheet</i>、<i>range</i>、<i>filteredRows</i>、<i>filteredOutRows</i>を含むオブジェクト。詳細については、「解説」を参照してください。

戻り値

void

継承元

RowFilterBase.onFilter

---

openFilterDialog

▸ openFilterDialog(filterButtonHitInfo): void

ユーザーがフィルタボタンをクリックしたときにフィルタダイアログを開きます。

パラメータ

名前	型	説明
filterButtonHitInfo	IFilterButtonHitInfo	フィルタボタンに関するヒットテスト情報。

戻り値

void

継承元

RowFilterBase.openFilterDialog

---

removeFilterItems

▸ removeFilterItems(col): void

指定したフィルタを削除します。

パラメータ

名前	型	説明
col	number	列インデックス。

戻り値

void

継承元

RowFilterBase.removeFilterItems

---

reset

▸ reset(): void

すべてのフィルタをクリアします。

戻り値

void

継承元

RowFilterBase.reset

---

sortColumn

▸ sortColumn(col, ascending): void

指定した列を指定した順にソートします。

パラメータ

名前	型	説明
col	number	列インデックス。
ascending	boolean	昇順にソートする場合、<c>true</c>に設定します。

戻り値

void

継承元

RowFilterBase.sortColumn

---

toJSON

▸ toJSON(): Object

オブジェクト状態をJSON文字列に保存します。

戻り値

Object

行フィルタのデータ。

継承元

RowFilterBase.toJSON

---

unfilter

▸ unfilter(col?): void

指定した列からフィルタを削除します。

パラメータ

名前	型	説明
col?	number	フィルタを削除する列のインデックス。これを省略した場合、範囲内のすべての列のフィルタが削除されます。

戻り値

void

継承元

RowFilterBase.unfilter