Excel.TableColumn class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

列に適用されているフィルターを取得します。

readonly filter: Excel.Filter;

プロパティ値

注釈

API セット: ExcelApi 1.2

テーブル内の列を識別する一意のキーを返します。

readonly id: number;

プロパティ値

注釈

API セット: ExcelApi 1.1

テーブルの列コレクション内の列のインデックス番号を返します。 0 を起点とする番号になります。

readonly index: number;

プロパティ値

注釈

API セット: ExcelApi 1.1

テーブルの列の名前を指定します。

name: string;

プロパティ値

注釈

API セット: ExcelApi 1.1 (名前の取得用)。1.4 設定を行います。

指定した範囲の Raw 値を表します。 返されるデータは、文字列、数値、またはブール値を指定できます。 エラーが含まれているセルは、エラー文字列を返します。 返された値がプラス ("+")、マイナス ("-")、または等号 ("=") で始まる場合、Excel はこの値を数式として解釈します。

values: any[][];

プロパティ値

注釈

API セット: ExcelApi 1.1

このテーブル列のセルの値の JSON 表現。 TableColumn.values とは異なり、TableColumn.valuesAsJson はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常に en-US ロケールに合わせて調整されます。 ユーザーの表示ロケールでデータを取得するには、 TableColumn.valuesAsJsonLocal を使用します。

valuesAsJson: CellValue[][];

プロパティ値

注釈

API セット: ExcelApi 1.16

このテーブル列のセルの値の JSON 表現。 TableColumn.values とは異なり、TableColumn.valuesAsJsonLocal はセル内のすべてのデータ型をサポートします。 たとえば、標準のブール値、数値値、文字列値に加えて、書式設定された数値や Web 画像などがあります。 この API から返されるデータは、常にユーザーの表示ロケールに合わせて調整されます。 ロケールに関係なくデータを取得するには、 TableColumn.valuesAsJson を使用します。

valuesAsJsonLocal: CellValue[][];

プロパティ値

注釈

API セット: ExcelApi 1.16

テーブルから列を削除します。

delete(): void;

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItemAt(2);
    column.delete();
    await context.sync(); 
});

列のデータ本体に関連付けられた範囲オブジェクトを取得します。

getDataBodyRange(): Excel.Range;

返品

注釈

API セット: ExcelApi 1.1

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml

// Add checkboxes to the table.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Get the second column in the table, without the header.
  const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

  // Change the boolean values to checkboxes.
  range.control = {
    type: Excel.CellControlType.checkbox
  };
  await context.sync();
});

列のヘッダー行に関連付けられた範囲オブジェクトを取得します。

getHeaderRowRange(): Excel.Range;

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const headerRowRange = columns.getHeaderRowRange();
    headerRowRange.load('address');
    await context.sync();
    
    console.log(headerRowRange.address);
});

列全体に関連付けられた範囲オブジェクトを取得します。

getRange(): Excel.Range;

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const columnRange = columns.getRange();
    columnRange.load('address');
    await context.sync();
    
    console.log(columnRange.address);
});

列の集計行に関連付けられた範囲オブジェクトを取得します。

getTotalRowRange(): Excel.Range;

返品

注釈

API セット: ExcelApi 1.1

例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const totalRowRange = columns.getTotalRowRange();
    totalRowRange.load('address');
    await context.sync();
    
    console.log(totalRowRange.address);
});

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.TableColumn;

パラメーター

返品

例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItem(0);
    column.load('index');
    await context.sync();
    
    console.log(column.index);
});

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TableColumn;

パラメーター

返品

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.TableColumn): void;

パラメーター

返品

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.TableColumn オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TableColumnData と型指定) を返します。

toJSON(): Excel.Interfaces.TableColumnData;

返品