クラス: View

GC.Data.View

Table of contents

コンストラクタ

• constructor

プロパティ

• autoFilter
• autoSort

メソッド

• addColumn
• addStyleRule
• clearStyleRules
• fetch
• getColumn
• getStyleRule
• length
• removeColumn
• removeStyleRule
• visibleLength

コンストラクタ

constructor

• new View(name, columnInfos?, includeDefaultColumns?, options?)

ビューを表します。

プロパティ name - 列の一意の名前。

プロパティ [value] - 列の値。 データベースのテーブルのフィールド名、またはフィールド名を使用する数式の場合があります。

プロパティ {string | string[]} [caption] - 列のキャプション。

プロパティ {number | string} [width] - 列の幅。 ピクセル単位の数値、またはスターサイズをサポートします。

プロパティ [style] - 列スタイルのオプション。

プロパティ {(GC.Data.CellValueRuleOptions | GC.Data.SpecificTextRuleOptions | GC.Data.FormulaRuleOptions | GC.Data.DateOccurringRuleOptions | GC.Data.Top10RuleOptions | GC.Data.UniqueRuleOptions | GC.Data.DuplicateRuleOptions | GC.Data.AverageRuleOptions | GC.Data.TwoScaleRuleOptions | GC.Data.ThreeScaleRuleOptions | GC.Data.DataBarRuleOptions | GC.Data.IconSetRuleOptions)[]} [conditionalFormats] - 条件付きルールの配列。

プロパティ {GC.Data.NumberValidatorOptions | GC.Data.DateValidatorOptions | GC.Data.TimeValidatorOptions | GC.Data.TextLengthValidatorOptions | GC.Data.FormulaValidatorOptions | GC.Data.FormulaListValidatorOptions | GC.Data.ListValidatorOptions} [validators] - デフォルトのデータバリデーター。

プロパティ [isPrimaryKey] - 列を主キー列にします。

プロパティ [readonly] - 列を読み取り専用にします。

プロパティ [required] - 新しい行を挿入するときに、列を必須としてマークします。

プロパティ [defaultValue] - 新しい行を挿入するときにデフォルト値を指定します。定数または数式にすることができます。

プロパティ [style] - 列ヘッダスタイルのオプション。

パラメータ

名前	型	説明
name	string	ビューの名前。
columnInfos?	string[] | IColumn[]	-
includeDefaultColumns?	boolean	-
options?	ViewOptions	-

プロパティ

autoFilter

• autoFilter: boolean

データが変更された後に再度フィルタリングするかどうか。 デフォルト値はtrueです。

---

autoSort

• autoSort: boolean

データが変更された後に再度ソートするかどうか。 デフォルト値はtrueです。

メソッド

addColumn

▸ addColumn(column): void

現在のビューに列を追加します。

実例

// ビューに列を追加します。
var productTable = dataManager.addTable("products", {
     remote: {
        read: {
            url: "https://demodata.mescius.io/northwind/api/v1/products"
        }
    }
});
var productView = productTable.addView("productView", [ "id", "name" ]);
productTable.fetch().then(function() {
    productView.addColumn("reorderLevel");
    productView.addColumn({ value: "unitPrice", caption: "UNIT PRICE" });
});

パラメータ

名前	型	説明
column	string | IColumn	列の文字列またはオブジェクト。 パラメータが文字列の場合、列名と値は文字列です。

戻り値

void

---

addStyleRule

▸ addStyleRule(name, style?, rule?): void

表示にスタイルルールを追加します。

実例

// 次のサンプルコードは、スタイルルールを追加します。
view.addStyleRule("dirtyRowStyle", { backColor: "yellow" }, {
   direction: GC.Data.StateRuleDirection.row,
   state: GC.Data.RowColumnStates.dirty
});

パラメータ

名前	型	説明
name	string	スタイルルール名。
style?	StyleOptions	-
rule?	FormulaRule | StateRule	-

戻り値

void

---

clearStyleRules

▸ clearStyleRules(): void

表示からすべてのスタイルルールをクリアします。

実例

// スタイルルールを削除します。
view.clearStyleRules();

戻り値

void

---

fetch

▸ fetch(reload?): Promise<any>

ホストテーブルと関連するテーブルからビューデータを要求します。

実例

// カスタムビューでテーブルシートを設定します。
var tablesheet = spread.addSheetTab(0, "TableSheet1", GC.Spread.Sheets.SheetType.tableSheet);
var dataManager = new GC.Data.DataManager();
var productTable = dataManager.addTable("productTable", {
    remote: {
        read: {
            url: "https://demodata.mescius.io/northwind/api/v1/products"
        }
    }
});
var productView = productTable.addView("productView", [
    "id", "name", "reorderLevel", "unitPrice", "unitsInStock", "unitsOnOrder"
]);
productView.fetch().then(function () {
    // ビューでデータソースを設定します。
    tablesheet.setDataView(productView);
});

パラメータ

名前	型
reload?	boolean

戻り値

Promise<any>

解決するPromiseのthen。 Promise.then()でデータを取得できます。

---

getColumn

▸ getColumn(index?): IColumn | IColumn[]

現在のビューの列を取得します。

実例

// すべての列を取得します
var allColumns = productWithSupplierView.getColumn();
// 2番目の列を取得します。
var column1 = productWithSupplierView.getColumn(1);

パラメータ

名前	型
index?	number

戻り値

IColumn | IColumn[]

指定されたインデックスで列を返すか、パラメータが省略されている場合は、すべての列を返します。

---

getStyleRule

▸ getStyleRule(name?): undefined | StyleRule | StyleRules

スタイルルールまたはすべてのスタイルルールを取得します。

実例

// スタイルルールを取得します。
view.getStyleRule("dirtyRowStyle");
// すべてのスタイルルールを取得します。
view.getStyleRule();

パラメータ

名前	型
name?	string

戻り値

undefined | StyleRule | StyleRules

スタイルルールまたはすべてのスタイルルールを返します。

---

length

▸ length(): number

表示ホストのテーブルのデータソースの長さを取得します。

実例

// データを取得した後、ビューデータソースの長さを取得できます。
let dataSourceLength = productView.length();

戻り値

number

ホストテーブルのデータソースの長さ。

---

removeColumn

▸ removeColumn(column): void

現在のビューから列を削除します。

実例

// 列を削除します。
productWithSupplierView.removeColumn("discontinued");

パラメータ

名前	型	説明
column	string	列の値。

戻り値

void

---

removeStyleRule

▸ removeStyleRule(name): void

表示に名前でスタイルルールを追加します。

実例

// スタイルルールを削除します。
view.removeStyleRule("dirtyRowStyle");

パラメータ

名前	型	説明
name	string	スタイルルール名。

戻り値

void

---

visibleLength

▸ visibleLength(): number

現在のビューで表示されるデータの長さを取得します。

実例

// データを取得した後、ビューのvisibleLengthを取得できます。
let viewVisibleLength = productView.visibleLength();

戻り値

number

現在のビューで表示されるデータの長さ。