ExcelScript.Worksheet interface

パッケージ:

ExcelScript

Excel のワークシートは、セルのグリッドです。 データ、表、グラフなどを含めることができます。

注釈

例

/**
 * This script creates a new worksheet named "Plum" and sets its tab color to purple.
 */
function main(workbook: ExcelScript.Workbook) {
  const newSheet = workbook.addWorksheet("Plum")
  newSheet.setTabColor("purple");
}

メソッド

activate()	Excel UI でワークシートをアクティブにします。
addChart(type, sourceData, seriesBy)	新しいグラフを作成します。
addComment(cellAddress, content, contentType)	指定したセルで、指定した内容の新しいコメントを作成します。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。
addGeometricShape(geometricShapeType)	幾何学的図形をワークシートに追加します。 新しい図形を表す Shape オブジェクトを返します。
addGroup(values)	このコレクションのワークシート内の図形のサブセットをグループ化します。 図形の新しいグループを表す Shape オブジェクトを返します。
addHorizontalPageBreak(pageBreakRange)	指定された範囲の左上セルの前に改ページを追加します。
addImage(base64ImageString)	base64 エンコード文字列から画像を作成し、それをワークシートに追加します。 新しいイメージを表す Shape オブジェクトを返します。
addLine(startLeft, startTop, endLeft, endTop, connectorType)	ワークシートに行を追加します。 新しい行を表す Shape オブジェクトを返します。
addNamedItem(name, reference, comment)	指定のスコープのコレクションに新しい名前を追加します。
addNamedItemFormulaLocal(name, formula, comment)	ユーザーのロケールを数式に使用して、指定のスコープのコレクションに新しい名前を追加します。
addNamedSheetView(name)	指定した名前の新しいシート ビューを作成します。
addPivotTable(name, source, destination)	指定したソース データに基づいてピボットテーブルを追加し、変換先範囲の左上のセルに挿入します。
addSlicer(slicerSource, sourceField, slicerDestination)	ブックに新しいスライサーを追加します。
addTable(address, hasHeaders)	新しいテーブルを作成します。 範囲オブジェクトまたはソース アドレスにより、テーブルが追加されるワークシートが判断されます。 テーブルが追加できない場合 (たとえば、アドレスが無効な場合や、テーブルが別のテーブルと重複している場合) は、エラーがスローされます。
addTextBox(text)	指定されたテキストを含むテキスト ボックスをワークシートに追加します。 新しいテキスト ボックスを表す Shape オブジェクトを返します。
addVerticalPageBreak(pageBreakRange)	指定された範囲の左上セルの前に改ページを追加します。
addWorksheetCustomProperty(key, value)	指定したキーにマップする新しいカスタム プロパティを追加します。 これにより、既存のカスタム プロパティがそのキーで上書きされます。
calculate(markAllDirty)	ワークシート上のすべてのセルを計算します。
copy(positionType, relativeTo)	ワークシートをコピーし、指定した位置に配置します。
delete()	ブックからワークシートを削除します。 ワークシートの可視性が "VeryHidden" に設定されている場合、削除操作は InvalidOperation 例外で失敗します。 削除する前に、最初にその可視性を非表示または表示に変更する必要があります。
enterTemporaryNamedSheetView()	新しい一時シート ビューを作成してアクティブにします。 一時ビューは、アプリケーションを閉じたり、exit メソッドを使用して一時ビューを終了したり、別のシート ビューに切り替えたりするときに削除されます。 一時ビューが存在する場合は、空の文字列 ("") を使用して一時シート ビューにアクセスすることもできます。
exitActiveNamedSheetView()	現在アクティブなシート ビューを終了します。
findAll(text, criteria)	指定した条件に基づいて指定された文字列のすべての出現箇所を検索し、1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトとして返します。
getActiveNamedSheetView()	ワークシートの現在アクティブなシート ビューを取得します。
getAutoFilter()	ワークシートの AutoFilter オブジェクトを表します。
getCell(row, column)	行番号と列番号に基づいて、1 つのセルを含む Range オブジェクトを取得します。 セルは、ワークシートのグリッド内に留まる限り、親範囲の範囲外にすることができます。
getChart(name)	グラフ名を使用してグラフを取得します。 同じ名前の複数のグラフがある場合は、最初の 1 つが返されます。 グラフが存在しない場合、このメソッドは undefinedを返します。
getCharts()	ワークシートの一部であるグラフのコレクションを返します。
getComment(commentId)	ID に基づいてコレクションからコメントを取得します。 コメント オブジェクトが存在しない場合、このメソッドは undefinedを返します。
getCommentByCell(cellAddress)	指定したセルからコメントを取得します。 セルにコメントがない場合は、エラーがスローされます。
getCommentByReplyId(replyId)	指定された応答が接続されているコメントを取得します。
getComments()	ワークシート上のすべての Comments オブジェクトの集まりを返します。
getCustomProperties()	ワークシート レベルのカスタム プロパティのコレクションを取得します。
getEnableCalculation()	Excel が必要に応じてワークシートを再計算するかどうかを決定します。 True を指定すると、必要に応じてワークシートが再計算されます。 False を指定すると、Excel でシートが再計算されません。
getFreezePanes()	ワークシート上の固定ウィンドウを操作するために使用できるオブジェクトを取得します。
getHorizontalPageBreaks()	ワークシートの水平改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。
getId()	指定されたブックのワークシートを一意に識別する値を返します。 この識別子の値は、ワークシートの名前を変更したり移動したりしても同じままです。
getName()	ワークシートの表示名。 名前は 32 文字未満にする必要があります。
getNamedItem(name)	名前を使用して NamedItem オブジェクトを取得します。 オブジェクトが存在しない場合、このメソッドは undefinedを返します。
getNamedSheetView(key)	名前を使用してシート ビューを取得します。 シート ビュー オブジェクトが存在しない場合、このメソッドは undefinedを返します。
getNamedSheetViews()	ワークシートに存在するシート ビューのコレクションを返します。
getNames()	現在のワークシートにスコープされている名前のコレクション。
getNext(visibleOnly)	このワークシートに続くワークシートを取得します。 このワークシートの後にワークシートがない場合、このメソッドは undefinedを返します。
getPageLayout()	ワークシートの PageLayout オブジェクトを取得します。
getPivotTable(name)	名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは undefinedを返します。
getPivotTables()	ワークシートの一部になっているピボットテーブルのコレクション。
getPosition()	0 を起点とした、ブック内のワークシートの位置。
getPrevious(visibleOnly)	このワークシートの前にあるワークシートを取得します。 以前のワークシートがない場合、このメソッドは undefinedを返します。
getProtection()	ワークシートのシート保護オブジェクトを返します。
getRange(address)	アドレスまたは名前で指定された単一の四角形のセル ブロックを表す、 Range オブジェクトを取得します。
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)	特定の行インデックスと列インデックスから始まり、特定の数の行と列にまたがる Range オブジェクトを取得します。
getRanges(address)	アドレスまたは名前で指定された四角形の範囲の 1 つ以上のブロックを表す、 RangeAreas オブジェクトを取得します。
getShape(key)	名前または ID を使用して図形を取得します。 shape オブジェクトが存在しない場合、このメソッドは undefinedを返します。
getShapes()	ワークシート上のすべての Shape オブジェクトをまとめて返します。
getShowGridlines()	グリッド線をユーザーに表示するかどうかを指定します。
getShowHeadings()	見出しをユーザーに表示するかどうかを指定します。
getSlicer(key)	名前または ID を使用してスライサーを取得します。 スライサーが存在しない場合、このメソッドは undefinedを返します。
getSlicers()	ワークシートの一部であるスライサーのコレクションを返します。
getStandardHeight()	ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。
getStandardWidth()	ワークシート内のすべての列の標準 (既定) 幅を指定します。 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。 プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。
getTabColor()	ワークシートのタブの色。 タブの色を取得するときに、ワークシートが非表示の場合、値は nullされます。 ワークシートが表示されていても、タブの色が auto に設定されている場合は、空の文字列が返されます。 それ以外の場合、プロパティは #RRGGBB 形式 ("FFA500" など) の色に設定されます。 色を設定するときは、空の文字列を使用して "自動" 色を設定するか、それ以外の場合は実際の色を設定します。
getTabId()	Open Office XML で読み取ることができるこのワークシートを表す値を返します。 これは整数値であり、 worksheet.id (グローバルに一意の識別子を返します) と worksheet.name ("Sheet1" などの値を返します) とは異なります。
getTable(key)	名前または ID でテーブルを取得します。 テーブルが存在しない場合、このメソッドは undefinedを返します。
getTables()	ワークシートの一部になっているグラフのコレクション。
getUsedRange(valuesOnly)
getVerticalPageBreaks()	ワークシートの垂直改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。
getVisibility()	ワークシートの可視性。
getWorksheetCustomProperty(key)	キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。 カスタム プロパティが存在しない場合、このメソッドは undefinedを返します。
refreshAllPivotTables()	コレクション内のすべてのピボットテーブルを更新します。
removeAllHorizontalPageBreaks()	コレクション内の手動改ページをすべてリセットします。
removeAllVerticalPageBreaks()	コレクション内の手動改ページをすべてリセットします。
replaceAll(text, replacement, criteria)	現在のワークシート内で、指定された条件に基づき、指定された文字列を検索し、置換します。
setEnableCalculation(enableCalculation)	Excel が必要に応じてワークシートを再計算するかどうかを決定します。 True を指定すると、必要に応じてワークシートが再計算されます。 False を指定すると、Excel でシートが再計算されません。
setName(name)	ワークシートの表示名。 名前は 32 文字未満にする必要があります。
setPosition(position)	0 を起点とした、ブック内のワークシートの位置。
setShowGridlines(showGridlines)	グリッド線をユーザーに表示するかどうかを指定します。
setShowHeadings(showHeadings)	見出しをユーザーに表示するかどうかを指定します。
setStandardWidth(standardWidth)	ワークシート内のすべての列の標準 (既定) 幅を指定します。 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。 プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。
setTabColor(tabColor)	ワークシートのタブの色。 タブの色を取得するときに、ワークシートが非表示の場合、値は nullされます。 ワークシートが表示されていても、タブの色が auto に設定されている場合は、空の文字列が返されます。 それ以外の場合、プロパティは #RRGGBB 形式 ("FFA500" など) の色に設定されます。 色を設定するときは、空の文字列を使用して "自動" 色を設定するか、それ以外の場合は実際の色を設定します。
setVisibility(visibility)	ワークシートの可視性。
showOutlineLevels(rowLevels, columnLevels)	行グループまたは列グループをアウトライン レベル別に表示します。 グループのアウトラインを作成し、ワークシート内のデータの一覧を要約します。 rowLevelsパラメーターと columnLevels パラメーターは、アウトラインを表示するレベルの数を指定します。 許容される引数の範囲は 0 ~ 8 です。 値が 0 の場合、現在の表示は変更されません。 現在のレベル数より大きい値は、すべてのレベルを表示します。

メソッドの詳細

activate()

Excel UI でワークシートをアクティブにします。

activate(): void;

戻り値

void

例

/**
 * This script switches the active view to a worksheet named "Data", if it exists.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet exists.
  let dataWorksheet = workbook.getWorksheet("Data");
  if (dataWorksheet) {
    // Switch to the "Data" worksheet.
    dataWorksheet.activate();
  } else {
    console.log(`No worksheet named "Data" in this workbook.`);
  }
}

addChart(type, sourceData, seriesBy)

新しいグラフを作成します。

addChart(
            type: ChartType,
            sourceData: Range,
            seriesBy?: ChartSeriesBy
        ): Chart;

パラメーター

type

ExcelScript.ChartType

グラフの種類を表します。 詳細は「ExcelScript.ChartType」をご覧ください。

sourceData

ExcelScript.Range

ソース データに対応する Range オブジェクト。

seriesBy

ExcelScript.ChartSeriesBy

省略可能。 列や行がグラフのデータ系列として使用される方法を指定します。 詳細は「ExcelScript.ChartSeriesBy」をご覧ください。

戻り値

ExcelScript.Chart

例

/**
 * This sample creates a column-clustered chart based on the current worksheet's data.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the data range.
  let range = selectedSheet.getUsedRange();

  // Insert a chart using the data on the current worksheet.
  let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);

  // Name the chart for easy access in other scripts.
  chart.setName("ColumnChart");
}

addComment(cellAddress, content, contentType)

指定したセルで、指定した内容の新しいコメントを作成します。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。

addComment(
            cellAddress: Range | string,
            content: CommentRichContent | string,
            contentType?: ContentType
        ): Comment;

パラメーター

cellAddress

ExcelScript.Range | string

コメントが追加されるセル。 これは、 Range オブジェクトまたは文字列です。 文字列の場合は、シート名を含む完全なアドレスを含む必要があります。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。

content

ExcelScript.CommentRichContent | string

コメントの内容。 これは、文字列または CommentRichContent オブジェクトのいずれかです。 文字列はプレーン テキストに使用されます。 CommentRichContent オブジェクトを使用すると、メンションなどの他のコメント機能を使用できます。

contentType

ExcelScript.ContentType

省略可能。 コメントに含まれるコンテンツの種類。 既定値は enum ContentType.Plainです。

戻り値

ExcelScript.Comment

addGeometricShape(geometricShapeType)

幾何学的図形をワークシートに追加します。 新しい図形を表す Shape オブジェクトを返します。

addGeometricShape(geometricShapeType: GeometricShapeType): Shape;

パラメーター

geometricShapeType

ExcelScript.GeometricShapeType

ジオメトリ シェイプの種類を表します。 詳細は「ExcelScript.GeometricShapeType」をご覧ください。

戻り値

ExcelScript.Shape

例

/**
 * This script creates a hexagon shape on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const hexagon: ExcelScript.Shape = 
    currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
  
  // Set the hexagon size to 40x40 pixels.
  hexagon.setHeight(40);
  hexagon.setWidth(40);

  // Position the hexagon at [100,100] pixels.
  hexagon.setLeft(100);
  hexagon.setTop(100);
}

addGroup(values)

このコレクションのワークシート内の図形のサブセットをグループ化します。 図形の新しいグループを表す Shape オブジェクトを返します。

addGroup(values: Array<string | Shape>): Shape;

パラメーター

values

Array<string | ExcelScript.Shape>

図形 ID または図形オブジェクトの配列。

戻り値

ExcelScript.Shape

addHorizontalPageBreak(pageBreakRange)

指定された範囲の左上セルの前に改ページを追加します。

addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;

パラメーター

pageBreakRange

ExcelScript.Range | string

追加する改ページの直後の範囲。

戻り値

ExcelScript.PageBreak

addImage(base64ImageString)

base64 エンコード文字列から画像を作成し、それをワークシートに追加します。 新しいイメージを表す Shape オブジェクトを返します。

addImage(base64ImageString: string): Shape;

パラメーター

base64ImageString

string

JPEG または PNG 形式の画像を表す base64 でエンコードされた文字列。

戻り値

ExcelScript.Shape

例

/**
 * This sample copies an image from a URL. 
 * This could be used to copy photos that a colleague stored in a shared folder to a related workbook.
 */
async function main(workbook: ExcelScript.Workbook) {
  // Fetch the image from a URL.
  const link = "https://raw.githubusercontent.com/OfficeDev/office-scripts-docs/master/docs/images/git-octocat.png";
  const response = await fetch(link);

  // Store the response as an ArrayBuffer, since it is a raw image file.
  const data = await response.arrayBuffer();

  // Convert the image data into a base64-encoded string.
  const image = convertToBase64(data);

  // Add the image to the current worksheet.
  workbook.getActiveWorksheet().addImage(image);
}

/**
 * Converts an ArrayBuffer containing a .png image into a base64-encoded string.
 */
function convertToBase64(input: ArrayBuffer) {
  const uInt8Array = new Uint8Array(input);
  const count = uInt8Array.length;

  // Allocate the necessary space up front.
  const charCodeArray = new Array<string>(count) 
  
  // Convert every entry in the array to a character.
  for (let i = count; i >= 0; i--) { 
    charCodeArray[i] = String.fromCharCode(uInt8Array[i]);
  }

  // Convert the characters to base64.
  const base64 = btoa(charCodeArray.join(''));
  return base64;
}

addLine(startLeft, startTop, endLeft, endTop, connectorType)

ワークシートに行を追加します。 新しい行を表す Shape オブジェクトを返します。

addLine(
            startLeft: number,
            startTop: number,
            endLeft: number,
            endTop: number,
            connectorType?: ConnectorType
        ): Shape;

パラメーター

startLeft

number

線の始点からワークシートの左側までの距離をポイント単位で指定します。

startTop

number

線の始点からワークシートの上部までの距離をポイント単位で指定します。

endLeft

number

行の末尾からワークシートの左側までの距離をポイント単位で指定します。

endTop

number

線の終点からワークシートの上端までの距離をポイント単位で指定します。

connectorType

ExcelScript.ConnectorType

コネクタの種類を表します。 詳細は「ExcelScript.ConnectorType」をご覧ください。

戻り値

ExcelScript.Shape

addNamedItem(name, reference, comment)

指定のスコープのコレクションに新しい名前を追加します。

addNamedItem(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

パラメーター

name

string

名前付きの項目の名前。

reference

ExcelScript.Range | string

名前が参照する数式または範囲。

comment

string

省略可能。 名前付き項目に関連付けられているコメント。

戻り値

ExcelScript.NamedItem

addNamedItemFormulaLocal(name, formula, comment)

ユーザーのロケールを数式に使用して、指定のスコープのコレクションに新しい名前を追加します。

addNamedItemFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

パラメーター

name

string

名前付きの項目の名前。

formula

string

名前が参照するユーザーのロケールの数式。

comment

string

省略可能。 名前付き項目に関連付けられているコメント。

戻り値

ExcelScript.NamedItem

addNamedSheetView(name)

指定した名前の新しいシート ビューを作成します。

addNamedSheetView(name: string): NamedSheetView;

パラメーター

name

string

作成するシート ビューの名前。 指定された名前が既に存在するか、空であるか、ワークシートによって予約されている名前である場合にエラーをスローします。

戻り値

ExcelScript.NamedSheetView

addPivotTable(name, source, destination)

指定したソース データに基づいてピボットテーブルを追加し、変換先範囲の左上のセルに挿入します。

addPivotTable(
            name: string,
            source: Range | string | Table,
            destination: Range | string
        ): PivotTable;

パラメーター

name

string

新しいピボットテーブルの名前。

source

ExcelScript.Range | string | ExcelScript.Table

新しいピボットテーブルのソース データは、範囲 (またはワークシート名を含む文字列アドレス) またはテーブルのいずれかです。

destination

ExcelScript.Range | string

ピボットテーブル レポートの配置先範囲 (結果のレポートを配置するワークシートの範囲) の左上端のセルを指定します。

戻り値

ExcelScript.PivotTable

例

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));

  // Switch to the new worksheet.
  newSheet.activate();
}

addSlicer(slicerSource, sourceField, slicerDestination)

ブックに新しいスライサーを追加します。

addSlicer(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

パラメーター

slicerSource

string | ExcelScript.PivotTable | ExcelScript.Table

新しいスライサーの基になるデータ ソース。 PivotTable オブジェクト、Table オブジェクト、または文字列を指定できます。 ピボットテーブル オブジェクトが渡されると、データ ソースは PivotTable オブジェクトのソースになります。 Table オブジェクトが渡されると、データ ソースは Table オブジェクトです。 文字列が渡されると、ピボットテーブルまたはテーブルの名前または ID として解釈されます。

sourceField

string | ExcelScript.PivotField | number | ExcelScript.TableColumn

フィルター処理するデータ ソースのフィールド。 PivotField オブジェクト、TableColumn オブジェクト、PivotFieldの ID、またはTableColumnの名前または ID を指定できます。

slicerDestination

string | ExcelScript.Worksheet

省略可能。 新しいスライサーが作成されるワークシート。 Worksheet オブジェクト、またはワークシートの名前または ID を指定できます。 スライサー コレクションがワークシートから取得される場合は、このパラメーターを省略できます。

戻り値

ExcelScript.Slicer

例

/**
 * This script adds a slicer for an existing PivotTable on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable from the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const pivot = currentSheet.getPivotTables()[0];

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const slicer = currentSheet.addSlicer(
    pivot, /* The table or PivotTale to be sliced. */
    pivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  slicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  slicer.setLeft(400);
}

addTable(address, hasHeaders)

新しいテーブルを作成します。 範囲オブジェクトまたはソース アドレスにより、テーブルが追加されるワークシートが判断されます。 テーブルが追加できない場合 (たとえば、アドレスが無効な場合や、テーブルが別のテーブルと重複している場合) は、エラーがスローされます。

addTable(address: Range | string, hasHeaders: boolean): Table;

パラメーター

address

ExcelScript.Range | string

Range オブジェクト、またはデータ ソースを表す文字列アドレスまたは範囲の名前。 アドレスにシート名が含まれていない場合は、現在作業中のシートが使用されます。

hasHeaders

boolean

インポートされるデータに列ラベルがあるかどうかを示すブール値。 ソースにヘッダーが含まれていない場合 (つまり、このプロパティが false に設定されている場合)、Excel はヘッダーを自動的に生成し、データを 1 行ずつシフトします。

戻り値

ExcelScript.Table

例

/**
 * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Create a table with the used cells.
  let usedRange = selectedSheet.getUsedRange();
  let newTable = selectedSheet.addTable(usedRange, true);

  // Sort the table using the first column.
  newTable.getSort().apply([{ key: 0, ascending: true }]);
}

addTextBox(text)

指定されたテキストを含むテキスト ボックスをワークシートに追加します。 新しいテキスト ボックスを表す Shape オブジェクトを返します。

addTextBox(text?: string): Shape;

パラメーター

text

string

作成したテキスト ボックスに表示されるテキストを表します。

戻り値

ExcelScript.Shape

addVerticalPageBreak(pageBreakRange)

指定された範囲の左上セルの前に改ページを追加します。

addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;

パラメーター

pageBreakRange

ExcelScript.Range | string

追加する改ページの直後の範囲。

戻り値

ExcelScript.PageBreak

addWorksheetCustomProperty(key, value)

指定したキーにマップする新しいカスタム プロパティを追加します。 これにより、既存のカスタム プロパティがそのキーで上書きされます。

addWorksheetCustomProperty(
            key: string,
            value: string
        ): WorksheetCustomProperty;

パラメーター

key

string

カスタム プロパティ オブジェクトを識別するキー。 大文字と小文字は区別されません。キーは 255 文字に制限されています (値を大きくすると、 InvalidArgument エラーがスローされます)。

value

string

このカスタム プロパティの値。

戻り値

ExcelScript.WorksheetCustomProperty

calculate(markAllDirty)

ワークシート上のすべてのセルを計算します。

calculate(markAllDirty: boolean): void;

パラメーター

markAllDirty

boolean

True を指定すると、すべてダーティとしてマークされます。

戻り値

void

copy(positionType, relativeTo)

ワークシートをコピーし、指定した位置に配置します。

copy(
            positionType?: WorksheetPositionType,
            relativeTo?: Worksheet
        ): Worksheet;

パラメーター

positionType

ExcelScript.WorksheetPositionType

新しく作成されたワークシートを配置するブック内の場所。 既定値は "None" で、ワークシートの先頭にワークシートが挿入されます。

relativeTo

ExcelScript.Worksheet

新しく作成されたワークシートの位置を決定する既存のワークシート。 これは、 positionType が "Before" または "After" の場合にのみ必要です。

戻り値

ExcelScript.Worksheet

例

/**
 * This script duplicates a worksheet named "Template". 
 * The new worksheet is added after the template.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the worksheet named "Template".
  let template = workbook.getWorksheet("Template");

  // Copy the worksheet.
  let newSheet = template.copy(
    ExcelScript.WorksheetPositionType.after,
    template
  );

  // Name the worksheet using the current date.
  let date = new Date(Date.now());
  newSheet.setName(`${date.toDateString()}`);
}

delete()

ブックからワークシートを削除します。 ワークシートの可視性が "VeryHidden" に設定されている場合、削除操作は InvalidOperation 例外で失敗します。 削除する前に、最初にその可視性を非表示または表示に変更する必要があります。

delete(): void;

戻り値

void

例

/**
 * The following scripts removes the first worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first worksheet.
  let sheet = workbook.getWorksheets()[0];

  // Remove that worksheet from the workbook.
  sheet.delete();
}

enterTemporaryNamedSheetView()

新しい一時シート ビューを作成してアクティブにします。 一時ビューは、アプリケーションを閉じたり、exit メソッドを使用して一時ビューを終了したり、別のシート ビューに切り替えたりするときに削除されます。 一時ビューが存在する場合は、空の文字列 ("") を使用して一時シート ビューにアクセスすることもできます。

enterTemporaryNamedSheetView(): NamedSheetView;

戻り値

ExcelScript.NamedSheetView

exitActiveNamedSheetView()

現在アクティブなシート ビューを終了します。

exitActiveNamedSheetView(): void;

戻り値

void

findAll(text, criteria)

指定した条件に基づいて指定された文字列のすべての出現箇所を検索し、1 つまたは複数の四角形の範囲を含む RangeAreas オブジェクトとして返します。

findAll(text: string, criteria: WorksheetSearchCriteria): RangeAreas;

パラメーター

text

string

検索する文字列。

criteria

ExcelScript.WorksheetSearchCriteria

検索がセル全体と一致する必要があるか、大文字と小文字が区別されるかなど、追加の検索条件。

戻り値

ExcelScript.RangeAreas

例

/**
 * This script searches through a worksheet and finds cells containing "No". 
 * Those cells are filled with the color red.
 * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let worksheet = workbook.getActiveWorksheet();
  let noCells = worksheet.findAll("No", { completeMatch: true });

  // Set the fill color to red.
  noCells.getFormat().getFill().setColor("red");
}

getActiveNamedSheetView()

ワークシートの現在アクティブなシート ビューを取得します。

getActiveNamedSheetView(): NamedSheetView;

戻り値

ExcelScript.NamedSheetView

getAutoFilter()

ワークシートの AutoFilter オブジェクトを表します。

getAutoFilter(): AutoFilter;

戻り値

ExcelScript.AutoFilter

例

/**
 * This script creates an autoFilter on the worksheet that filters out rows based on column values. 
 * The autoFilter filters to only include rows that have a value in column D in the top 10 percentile 
 * (of column D values).
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();

  // Add a filter that will only show the rows with the top 10% of values in column D
  // (index 3, assuming the used range spans from at least A:D).
  currentSheet.getAutoFilter().apply(dataRange, 3, {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.topPercent
  });
}

getCell(row, column)

行番号と列番号に基づいて、1 つのセルを含む Range オブジェクトを取得します。 セルは、ワークシートのグリッド内に留まる限り、親範囲の範囲外にすることができます。

getCell(row: number, column: number): Range;

パラメーター

row

number

取得するセルの行番号。 0 を起点とする番号になります。

column

number

取得するセルの列番号。 0 を起点とする番号になります。

戻り値

ExcelScript.Range

getChart(name)

グラフ名を使用してグラフを取得します。 同じ名前の複数のグラフがある場合は、最初の 1 つが返されます。 グラフが存在しない場合、このメソッドは undefinedを返します。

getChart(name: string): Chart | undefined;

パラメーター

name

string

取得するグラフの名前。

戻り値

ExcelScript.Chart | undefined

例

/**
 * This sample moves an existing chart to a specific place on the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();
  
  // Get an existing chart named "ColumnChart".
  let chart = selectedSheet.getChart("ColumnChart");

  // Place the chart over the range "F1:L13".
  chart.setPosition("F1", "L13");
}

getCharts()

ワークシートの一部であるグラフのコレクションを返します。

getCharts(): Chart[];

戻り値

ExcelScript.Chart[]

getComment(commentId)

ID に基づいてコレクションからコメントを取得します。 コメント オブジェクトが存在しない場合、このメソッドは undefinedを返します。

getComment(commentId: string): Comment | undefined;

パラメーター

commentId

string

コメントの識別子。

戻り値

ExcelScript.Comment | undefined

getCommentByCell(cellAddress)

指定したセルからコメントを取得します。 セルにコメントがない場合は、エラーがスローされます。

getCommentByCell(cellAddress: Range | string): Comment;

パラメーター

cellAddress

ExcelScript.Range | string

コメントがオンになっているセル。 これは、 Range オブジェクトまたは文字列です。 文字列の場合は、シート名を含む完全なアドレスを含む必要があります。 指定された範囲が 1 つのセルより大きい場合、 InvalidArgument エラーがスローされます。

戻り値

ExcelScript.Comment

getCommentByReplyId(replyId)

指定された応答が接続されているコメントを取得します。

getCommentByReplyId(replyId: string): Comment;

パラメーター

replyId

string

コメント応答の識別子。

戻り値

ExcelScript.Comment

getComments()

ワークシート上のすべての Comments オブジェクトの集まりを返します。

getComments(): Comment[];

戻り値

ExcelScript.Comment[]

getCustomProperties()

ワークシート レベルのカスタム プロパティのコレクションを取得します。

getCustomProperties(): WorksheetCustomProperty[];

戻り値

ExcelScript.WorksheetCustomProperty[]

getEnableCalculation()

Excel が必要に応じてワークシートを再計算するかどうかを決定します。 True を指定すると、必要に応じてワークシートが再計算されます。 False を指定すると、Excel でシートが再計算されません。

getEnableCalculation(): boolean;

戻り値

boolean

getFreezePanes()

ワークシート上の固定ウィンドウを操作するために使用できるオブジェクトを取得します。

getFreezePanes(): WorksheetFreezePanes;

戻り値

ExcelScript.WorksheetFreezePanes

getHorizontalPageBreaks()

ワークシートの水平改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。

getHorizontalPageBreaks(): PageBreak[];

戻り値

ExcelScript.PageBreak[]

getId()

指定されたブックのワークシートを一意に識別する値を返します。 この識別子の値は、ワークシートの名前を変更したり移動したりしても同じままです。

getId(): string;

戻り値

string

getName()

ワークシートの表示名。 名前は 32 文字未満にする必要があります。

getName(): string;

戻り値

string

例

/**
 * This sample gets all the worksheet names in the workbook.
 * It then logs those names to the console.
 */
function main(workbook: ExcelScript.Workbook) {
    // Create an array to hold the worksheet names.
    let worksheetNames = [];

    // Iterate over the worksheet collection in the workbook.
    for (let worksheet of workbook.getWorksheets()) {
        worksheetNames.push(worksheet.getName());
    }

    // Log the array of worksheet names.
    console.log(worksheetNames);
}

getNamedItem(name)

名前を使用して NamedItem オブジェクトを取得します。 オブジェクトが存在しない場合、このメソッドは undefinedを返します。

getNamedItem(name: string): NamedItem | undefined;

パラメーター

name

string

名前付き項目名。

戻り値

ExcelScript.NamedItem | undefined

getNamedSheetView(key)

名前を使用してシート ビューを取得します。 シート ビュー オブジェクトが存在しない場合、このメソッドは undefinedを返します。

getNamedSheetView(key: string): NamedSheetView | undefined;

パラメーター

key

string

シート ビューの大文字と小文字を区別する名前。 一時ビューが存在する場合は、空の文字列 ("") を使用して一時シート ビューを取得します。

戻り値

ExcelScript.NamedSheetView | undefined

getNamedSheetViews()

ワークシートに存在するシート ビューのコレクションを返します。

getNamedSheetViews(): NamedSheetView[];

戻り値

ExcelScript.NamedSheetView[]

getNames()

現在のワークシートにスコープされている名前のコレクション。

getNames(): NamedItem[];

戻り値

ExcelScript.NamedItem[]

getNext(visibleOnly)

このワークシートに続くワークシートを取得します。 このワークシートの後にワークシートがない場合、このメソッドは undefinedを返します。

getNext(visibleOnly?: boolean): Worksheet;

パラメーター

visibleOnly

boolean

省略可能。 true 場合は、非表示のワークシートをスキップして、表示されているワークシートのみを考慮します。

戻り値

ExcelScript.Worksheet

getPageLayout()

ワークシートの PageLayout オブジェクトを取得します。

getPageLayout(): PageLayout;

戻り値

ExcelScript.PageLayout

例

/**
 * This script sets the printing orientation for the entire workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();

    // Print every page with a landscape orientation.
    pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
  });
}

getPivotTable(name)

名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは undefinedを返します。

getPivotTable(name: string): PivotTable | undefined;

パラメーター

name

string

取得するピボットテーブルの名前。

戻り値

ExcelScript.PivotTable | undefined

getPivotTables()

ワークシートの一部になっているピボットテーブルのコレクション。

getPivotTables(): PivotTable[];

戻り値

ExcelScript.PivotTable[]

getPosition()

0 を起点とした、ブック内のワークシートの位置。

getPosition(): number;

戻り値

number

getPrevious(visibleOnly)

このワークシートの前にあるワークシートを取得します。 以前のワークシートがない場合、このメソッドは undefinedを返します。

getPrevious(visibleOnly?: boolean): Worksheet;

パラメーター

visibleOnly

boolean

省略可能。 true 場合は、非表示のワークシートをスキップして、表示されているワークシートのみを考慮します。

戻り値

ExcelScript.Worksheet

getProtection()

ワークシートのシート保護オブジェクトを返します。

getProtection(): WorksheetProtection;

戻り値

ExcelScript.WorksheetProtection

例

/**
 * This script protects cells from being selected on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the protection settings for the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const sheetProtection = currentSheet.getProtection();

  // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
  let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
    selectionMode: ExcelScript.ProtectionSelectionMode.none
  }

  // Apply the given protection options.
  sheetProtection.protect(protectionOptions);
}

getRange(address)

アドレスまたは名前で指定された単一の四角形のセル ブロックを表す、 Range オブジェクトを取得します。

getRange(address?: string): Range;

パラメーター

address

string

省略可能。 範囲のアドレスまたは名前を表す文字列。 たとえば、"A1:B2" です。 指定されていない場合は、ワークシート全体の範囲が返されます。

戻り値

ExcelScript.Range

例

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

特定の行インデックスと列インデックスから始まり、特定の数の行と列にまたがる Range オブジェクトを取得します。

getRangeByIndexes(
            startRow: number,
            startColumn: number,
            rowCount: number,
            columnCount: number
        ): Range;

パラメーター

startRow

number

開始行 (インデックスが 0)。

startColumn

number

開始列 (インデックスが 0)。

rowCount

number

範囲に含める行の数。

columnCount

number

範囲に含める列の数。

戻り値

ExcelScript.Range

getRanges(address)

アドレスまたは名前で指定された四角形の範囲の 1 つ以上のブロックを表す、 RangeAreas オブジェクトを取得します。

getRanges(address?: string): RangeAreas;

パラメーター

address

string

省略可能。 コンマ区切りまたはセミコロンで区切られたアドレスまたは個々の範囲の名前を含む文字列。 たとえば、"A1:B2、A5:B5" や "A1:B2;A5:B5" 指定しない場合は、ワークシート全体の RangeAreas オブジェクトが返されます。

戻り値

ExcelScript.RangeAreas

getShape(key)

名前または ID を使用して図形を取得します。 shape オブジェクトが存在しない場合、このメソッドは undefinedを返します。

getShape(key: string): Shape | undefined;

パラメーター

key

string

取得する図形の名前または ID。

戻り値

ExcelScript.Shape | undefined

getShapes()

ワークシート上のすべての Shape オブジェクトをまとめて返します。

getShapes(): Shape[];

戻り値

ExcelScript.Shape[]

getShowGridlines()

グリッド線をユーザーに表示するかどうかを指定します。

getShowGridlines(): boolean;

戻り値

boolean

getShowHeadings()

見出しをユーザーに表示するかどうかを指定します。

getShowHeadings(): boolean;

戻り値

boolean

getSlicer(key)

名前または ID を使用してスライサーを取得します。 スライサーが存在しない場合、このメソッドは undefinedを返します。

getSlicer(key: string): Slicer | undefined;

パラメーター

key

string

取得するスライサーの名前または ID。

戻り値

ExcelScript.Slicer | undefined

getSlicers()

ワークシートの一部であるスライサーのコレクションを返します。

getSlicers(): Slicer[];

戻り値

ExcelScript.Slicer[]

getStandardHeight()

ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。

getStandardHeight(): number;

戻り値

number

getStandardWidth()

ワークシート内のすべての列の標準 (既定) 幅を指定します。 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。 プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。

getStandardWidth(): number;

戻り値

number

getTabColor()

ワークシートのタブの色。 タブの色を取得するときに、ワークシートが非表示の場合、値は nullされます。 ワークシートが表示されていても、タブの色が auto に設定されている場合は、空の文字列が返されます。 それ以外の場合、プロパティは #RRGGBB 形式 ("FFA500" など) の色に設定されます。 色を設定するときは、空の文字列を使用して "自動" 色を設定するか、それ以外の場合は実際の色を設定します。

getTabColor(): string;

戻り値

string

getTabId()

Open Office XML で読み取ることができるこのワークシートを表す値を返します。 これは整数値であり、 worksheet.id (グローバルに一意の識別子を返します) と worksheet.name ("Sheet1" などの値を返します) とは異なります。

getTabId(): number;

戻り値

number

getTable(key)

名前または ID でテーブルを取得します。 テーブルが存在しない場合、このメソッドは undefinedを返します。

getTable(key: string): Table | undefined;

パラメーター

key

string

取得するテーブルの名前または ID。

戻り値

ExcelScript.Table | undefined

getTables()

ワークシートの一部になっているグラフのコレクション。

getTables(): Table[];

戻り値

ExcelScript.Table[]

getUsedRange(valuesOnly)

getUsedRange(valuesOnly?: boolean): Range;

パラメーター

valuesOnly

boolean

省略可能。 値の入っているセルのみを使用セルと見なします。

戻り値

ExcelScript.Range

getVerticalPageBreaks()

ワークシートの垂直改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。

getVerticalPageBreaks(): PageBreak[];

戻り値

ExcelScript.PageBreak[]

getVisibility()

ワークシートの可視性。

getVisibility(): SheetVisibility;

戻り値

ExcelScript.SheetVisibility

getWorksheetCustomProperty(key)

キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。 カスタム プロパティが存在しない場合、このメソッドは undefinedを返します。

getWorksheetCustomProperty(
            key: string
        ): WorksheetCustomProperty | undefined;

パラメーター

key

string

カスタム プロパティ オブジェクトを識別するキー。 大文字と小文字は区別されません。

戻り値

ExcelScript.WorksheetCustomProperty | undefined

refreshAllPivotTables()

コレクション内のすべてのピボットテーブルを更新します。

refreshAllPivotTables(): void;

戻り値

void

removeAllHorizontalPageBreaks()

コレクション内の手動改ページをすべてリセットします。

removeAllHorizontalPageBreaks(): void;

戻り値

void

removeAllVerticalPageBreaks()

コレクション内の手動改ページをすべてリセットします。

removeAllVerticalPageBreaks(): void;

戻り値

void

replaceAll(text, replacement, criteria)

現在のワークシート内で、指定された条件に基づき、指定された文字列を検索し、置換します。

replaceAll(
            text: string,
            replacement: string,
            criteria: ReplaceCriteria
        ): number;

パラメーター

text

string

検索する文字列。

replacement

string

元の文字列を置き換える文字列。

criteria

ExcelScript.ReplaceCriteria

追加の置き換え条件。

戻り値

number

setEnableCalculation(enableCalculation)

Excel が必要に応じてワークシートを再計算するかどうかを決定します。 True を指定すると、必要に応じてワークシートが再計算されます。 False を指定すると、Excel でシートが再計算されません。

setEnableCalculation(enableCalculation: boolean): void;

パラメーター

enableCalculation

boolean

戻り値

void

setName(name)

ワークシートの表示名。 名前は 32 文字未満にする必要があります。

setName(name: string): void;

パラメーター

name

string

戻り値

void

例

/**
 * This sample renames a worksheet from "Sheet1" to "SALES".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "Sheet1".
  const sheet = workbook.getWorksheet('Sheet1'); 

  // Set its name to SALES.
  sheet.setName('SALES');
}

setPosition(position)

0 を起点とした、ブック内のワークシートの位置。

setPosition(position: number): void;

パラメーター

position

number

戻り値

void

例

/**
 * This sample sets the worksheet named "SALES" as the first sheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "SALES".
  const sheet = workbook.getWorksheet('SALES'); 
  // Position the worksheet at the beginning of the workbook.
  sheet.setPosition(0);
}

setShowGridlines(showGridlines)

グリッド線をユーザーに表示するかどうかを指定します。

setShowGridlines(showGridlines: boolean): void;

パラメーター

showGridlines

boolean

戻り値

void

setShowHeadings(showHeadings)

見出しをユーザーに表示するかどうかを指定します。

setShowHeadings(showHeadings: boolean): void;

パラメーター

showHeadings

boolean

戻り値

void

setStandardWidth(standardWidth)

ワークシート内のすべての列の標準 (既定) 幅を指定します。 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。 プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。

setStandardWidth(standardWidth: number): void;

パラメーター

standardWidth

number

戻り値

void

setTabColor(tabColor)

ワークシートのタブの色。 タブの色を取得するときに、ワークシートが非表示の場合、値は nullされます。 ワークシートが表示されていても、タブの色が auto に設定されている場合は、空の文字列が返されます。 それ以外の場合、プロパティは #RRGGBB 形式 ("FFA500" など) の色に設定されます。 色を設定するときは、空の文字列を使用して "自動" 色を設定するか、それ以外の場合は実際の色を設定します。

setTabColor(tabColor: string): void;

パラメーター

tabColor

string

戻り値

void

例

/**
 * This script sets the tab color of every worksheet in the workbook to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();
  
  // Set the tab color of each worksheet to a random color.
  for (let sheet of sheets) {    
    // Set the color of the current worksheet's tab to red.
    sheet.setTabColor("red");
  }
}

setVisibility(visibility)

ワークシートの可視性。

setVisibility(visibility: SheetVisibility): void;

パラメーター

visibility

ExcelScript.SheetVisibility

戻り値

void

例

/**
 * This script unhides all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Iterate over each worksheet.
  workbook.getWorksheets().forEach((worksheet) => {
    // Set the worksheet visibility to visible.
    worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
  });
}

showOutlineLevels(rowLevels, columnLevels)

行グループまたは列グループをアウトライン レベル別に表示します。 グループのアウトラインを作成し、ワークシート内のデータの一覧を要約します。 rowLevelsパラメーターと columnLevels パラメーターは、アウトラインを表示するレベルの数を指定します。 許容される引数の範囲は 0 ~ 8 です。 値が 0 の場合、現在の表示は変更されません。 現在のレベル数より大きい値は、すべてのレベルを表示します。

showOutlineLevels(rowLevels: number, columnLevels: number): void;

パラメーター

rowLevels

number

表示するアウトラインの行レベルの数。

columnLevels

number

表示するアウトラインの列レベルの数。

戻り値

void