ExcelScript.Chart interface

リファレンス

パッケージ:: ExcelScript

ブック内のグラフオブジェクトを表します。

メソッド

activate()	Excel UI でグラフをアクティブにします。
addChartSeries(name, index)	コレクションに新しい系列を追加します。新しく追加された系列は、値、x 軸の値、またはバブルサイズが設定されるまで表示されません (グラフの種類に応じて)。
delete()	グラフオブジェクトを削除します。
getAxes()	グラフの軸を表します。
getCategoryLabelLevel()	ソースカテゴリラベルのレベルを参照するグラフカテゴリラベルレベル列挙定数を指定します。
getChartType()	グラフの種類を指定します。詳細は「`ExcelScript.ChartType`」をご覧ください。
getDataLabels()	グラフのデータラベルを表します。
getDataTable()	グラフのデータテーブルを取得します。グラフでデータテーブルが許可されていない場合、このメソッドは `undefined`を返します。
getDisplayBlanksAs()	空白のセルをグラフにプロットする方法を指定します。
getFormat()	グラフ領域の書式設定プロパティをカプセル化します。
getHeight()	グラフオブジェクトの高さをポイント単位で指定します。
getId()	グラフの一意の ID。
getImage(width, height, fittingMode)	指定したサイズに合わせてグラフを拡大、縮小することで、グラフを Base64 でエンコードされた画像としてレンダリングします。縦横比は、サイズ変更の一部として保持されます。
getLeft()	グラフの左側からワークシートの原点までの距離 (ポイント単位)。
getLegend()	グラフの凡例を表します。
getName()	グラフオブジェクトの名前を指定します。
getPivotOptions()	ピボットグラフのオプションをカプセル化します。
getPlotArea()	グラフのプロット領域を表します。
getPlotBy()	列や行がグラフのデータ系列として使用される方法を指定します。
getPlotVisibleOnly()	true の場合、可視セルだけがプロットされます。 false の場合、可視セルと非表示セルの両方がプロットされます。
getSeries()	グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。
getSeriesNameLevel()	ソース系列名のレベルを参照するグラフ系列名レベル列挙定数を指定します。
getShowAllFieldButtons()	ピボットグラフにすべてのフィールドボタンを表示するかどうかを指定します。
getShowDataLabelsOverMaximum()	値が値軸の最大値より大きい場合にデータラベルを表示するかどうかを指定します。値軸がデータポイントのサイズよりも小さくなった場合は、このプロパティを使用して、データラベルを表示するかどうかを設定できます。このプロパティは、2-D グラフにのみ使用できます。
getStyle()	グラフのグラフスタイルを指定します。
getTitle()	指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。
getTop()	オブジェクトの上端から行 1 の上端 (ワークシート上) またはグラフ領域 (グラフ上) の上端までの距離をポイント単位で指定します。
getWidth()	グラフオブジェクトの幅をポイント単位で指定します。
getWorksheet()	現在のグラフを含んでいるワークシート。
setCategoryLabelLevel(categoryLabelLevel)	ソースカテゴリラベルのレベルを参照するグラフカテゴリラベルレベル列挙定数を指定します。
setChartType(chartType)	グラフの種類を指定します。詳細は「`ExcelScript.ChartType`」をご覧ください。
setData(sourceData, seriesBy)	グラフの元データをリセットします。
setDisplayBlanksAs(displayBlanksAs)	空白のセルをグラフにプロットする方法を指定します。
setHeight(height)	グラフオブジェクトの高さをポイント単位で指定します。
setLeft(left)	グラフの左側からワークシートの原点までの距離 (ポイント単位)。
setName(name)	グラフオブジェクトの名前を指定します。
setPlotBy(plotBy)	列や行がグラフのデータ系列として使用される方法を指定します。
setPlotVisibleOnly(plotVisibleOnly)	true の場合、可視セルだけがプロットされます。 false の場合、可視セルと非表示セルの両方がプロットされます。
setPosition(startCell, endCell)	ワークシート上のセルを基準にしてグラフを配置します。
setSeriesNameLevel(seriesNameLevel)	ソース系列名のレベルを参照するグラフ系列名レベル列挙定数を指定します。
setShowAllFieldButtons(showAllFieldButtons)	ピボットグラフにすべてのフィールドボタンを表示するかどうかを指定します。
setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)	値が値軸の最大値より大きい場合にデータラベルを表示するかどうかを指定します。値軸がデータポイントのサイズよりも小さくなった場合は、このプロパティを使用して、データラベルを表示するかどうかを設定できます。このプロパティは、2-D グラフにのみ使用できます。
setStyle(style)	グラフのグラフスタイルを指定します。
setTop(top)	オブジェクトの上端から行 1 の上端 (ワークシート上) またはグラフ領域 (グラフ上) の上端までの距離をポイント単位で指定します。
setWidth(width)	グラフオブジェクトの幅をポイント単位で指定します。

メソッドの詳細

activate()

Excel UI でグラフをアクティブにします。

activate(): void;

戻り値

void

addChartSeries(name, index)

コレクションに新しい系列を追加します。新しく追加された系列は、値、x 軸の値、またはバブルサイズが設定されるまで表示されません (グラフの種類に応じて)。

addChartSeries(name?: string, index?: number): ChartSeries;

パラメーター

name: string

省略可能。系列の名前。

index: number

省略可能。追加する系列のインデックス値。 0 を起点とする番号になります。

戻り値

ExcelScript.ChartSeries

例

/**
 * This sample produces a line chart with two series.
 * The chart assumes data in A1:E5 that looks like this:
 * Product Qtr1 Qtr2 Qtr3 Qtr4
 * Frames 5000 7000 6544 4377
 * Saddles 400 323 276 651
 */
function main(workbook: ExcelScript.Workbook) {
  // Establish the ranges to use.
  const sheet = workbook.getActiveWorksheet();
  const headerRange = sheet.getRange("A1:E1");
  const firstSeriesRange = sheet.getRange("A2:E2");
  const secondSeriesRange = sheet.getRange("A3:E3");

  // Create the chart.
  const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);

  // Add the first chart series.
  const firstSeries = lineChart.addChartSeries();
  firstSeries.setXAxisValues(headerRange);
  firstSeries.setValues(firstSeriesRange);

  // Add the second chart series.
  const secondSeries = lineChart.addChartSeries();
  secondSeries.setXAxisValues(headerRange);
  secondSeries.setValues(secondSeriesRange);
}

delete()

グラフオブジェクトを削除します。

delete(): void;

戻り値

void

getAxes()

グラフの軸を表します。

getAxes(): ChartAxes;

戻り値

ExcelScript.ChartAxes

getCategoryLabelLevel()

ソースカテゴリラベルのレベルを参照するグラフカテゴリラベルレベル列挙定数を指定します。

getCategoryLabelLevel(): number;

戻り値

number

getChartType()

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

getChartType(): ChartType;

戻り値

ExcelScript.ChartType

getDataLabels()

グラフのデータラベルを表します。

getDataLabels(): ChartDataLabels;

戻り値

ExcelScript.ChartDataLabels

getDataTable()

グラフのデータテーブルを取得します。グラフでデータテーブルが許可されていない場合、このメソッドは undefinedを返します。

getDataTable(): ChartDataTable;

戻り値

ExcelScript.ChartDataTable

getDisplayBlanksAs()

空白のセルをグラフにプロットする方法を指定します。

getDisplayBlanksAs(): ChartDisplayBlanksAs;

戻り値

ExcelScript.ChartDisplayBlanksAs

getFormat()

グラフ領域の書式設定プロパティをカプセル化します。

getFormat(): ChartAreaFormat;

戻り値

ExcelScript.ChartAreaFormat

getHeight()

グラフオブジェクトの高さをポイント単位で指定します。

getHeight(): number;

戻り値

number

getId()

グラフの一意の ID。

getId(): string;

戻り値

string

getImage(width, height, fittingMode)

指定したサイズに合わせてグラフを拡大、縮小することで、グラフを Base64 でエンコードされた画像としてレンダリングします。縦横比は、サイズ変更の一部として保持されます。

getImage(
            width?: number,
            height?: number,
            fittingMode?: ImageFittingMode
        ): string;

パラメーター

width: number

省略可能。結果の画像の希望する幅。

height: number

省略可能。結果の画像の希望する高さ。

fittingMode: ExcelScript.ImageFittingMode

省略可能。グラフを指定したディメンションにスケーリングするために使用するメソッド (高さと幅の両方が設定されている場合)。

戻り値

string

例

/**
 * This script returns an image of the first chart in the first worksheet.
 * That image is 600x400 pixels and the chart will be 
 * stretched to fill those dimensions.
 * The returned image can be used in a Power Automate flow.
 */
function main(workbook: ExcelScript.Workbook): string {
  // Get the first chart in the first worksheet.
  const firstSheet = workbook.getFirstWorksheet();
  const firstChart = firstSheet.getCharts()[0];

  // Get an image of the chart as a base64-encoded string.
  const base64String = firstChart.getImage(
    600, /* Width */
    400, /* Height */
    ExcelScript.ImageFittingMode.fill /* Fill to match the dimensions. */
  );

  return base64String;
}

getLeft()

グラフの左側からワークシートの原点までの距離 (ポイント単位)。

getLeft(): number;

戻り値

number

getLegend()

グラフの凡例を表します。

getLegend(): ChartLegend;

戻り値

ExcelScript.ChartLegend

getName()

グラフオブジェクトの名前を指定します。

getName(): string;

戻り値

string

getPivotOptions()

ピボットグラフのオプションをカプセル化します。

getPivotOptions(): ChartPivotOptions;

戻り値

ExcelScript.ChartPivotOptions

getPlotArea()

グラフのプロット領域を表します。

getPlotArea(): ChartPlotArea;

戻り値

ExcelScript.ChartPlotArea

getPlotBy()

列や行がグラフのデータ系列として使用される方法を指定します。

getPlotBy(): ChartPlotBy;

戻り値

ExcelScript.ChartPlotBy

例

/**
 * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
  
  // Switch the row and column for the chart's data source.
  if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
    // If the chart is grouped by columns, switch it to rows.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
  } else {
    // If the chart is grouped by rows, switch it to columns.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
  }
}

getPlotVisibleOnly()

true の場合、可視セルだけがプロットされます。 false の場合、可視セルと非表示セルの両方がプロットされます。

getPlotVisibleOnly(): boolean;

戻り値

boolean

getSeries()

グラフの 1 つのデータ系列またはデータ系列のコレクションを表します。

getSeries(): ChartSeries[];

戻り値

ExcelScript.ChartSeries[]

例

/**
 * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let chart = selectedSheet.getChart("ColumnClusteredChart");

  // Set the overlap of every column of each series within a category.
  let seriesList = chart.getSeries();
  seriesList.forEach((series) => {
    // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
    series.setOverlap(25);
  });
}

getSeriesNameLevel()

ソース系列名のレベルを参照するグラフ系列名レベル列挙定数を指定します。

getSeriesNameLevel(): number;

戻り値

number

getShowAllFieldButtons()

ピボットグラフにすべてのフィールドボタンを表示するかどうかを指定します。

getShowAllFieldButtons(): boolean;

戻り値

boolean

getShowDataLabelsOverMaximum()

値が値軸の最大値より大きい場合にデータラベルを表示するかどうかを指定します。値軸がデータポイントのサイズよりも小さくなった場合は、このプロパティを使用して、データラベルを表示するかどうかを設定できます。このプロパティは、2-D グラフにのみ使用できます。

getShowDataLabelsOverMaximum(): boolean;

戻り値

boolean

getStyle()

グラフのグラフスタイルを指定します。

getStyle(): number;

戻り値

number

getTitle()

指定したグラフのタイトル (タイトルのテキスト、表示/非表示、位置、書式設定など) を表します。

getTitle(): ChartTitle;

戻り値

ExcelScript.ChartTitle

getTop()

オブジェクトの上端から行 1 の上端 (ワークシート上) またはグラフ領域 (グラフ上) の上端までの距離をポイント単位で指定します。

getTop(): number;

戻り値

number

getWidth()

グラフオブジェクトの幅をポイント単位で指定します。

getWidth(): number;

戻り値

number

getWorksheet()

現在のグラフを含んでいるワークシート。

getWorksheet(): Worksheet;

戻り値

ExcelScript.Worksheet

setCategoryLabelLevel(categoryLabelLevel)

ソースカテゴリラベルのレベルを参照するグラフカテゴリラベルレベル列挙定数を指定します。

setCategoryLabelLevel(categoryLabelLevel: number): void;

パラメーター

categoryLabelLevel: number

戻り値

void

setChartType(chartType)

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

setChartType(chartType: ChartType): void;

パラメーター

chartType: ExcelScript.ChartType

戻り値

void

setData(sourceData, seriesBy)

グラフの元データをリセットします。

setData(sourceData: Range, seriesBy?: ChartSeriesBy): void;

パラメーター

sourceData: ExcelScript.Range

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

seriesBy: ExcelScript.ChartSeriesBy

列や行がグラフのデータ系列として使用される方法を指定します。自動 (既定値)、行、列のいずれかを指定できます。詳細は「ExcelScript.ChartSeriesBy」をご覧ください。

戻り値

void

setDisplayBlanksAs(displayBlanksAs)

空白のセルをグラフにプロットする方法を指定します。

setDisplayBlanksAs(displayBlanksAs: ChartDisplayBlanksAs): void;

パラメーター

displayBlanksAs: ExcelScript.ChartDisplayBlanksAs

戻り値

void

setHeight(height)

グラフオブジェクトの高さをポイント単位で指定します。

setHeight(height: number): void;

パラメーター

height: number

戻り値

void

setLeft(left)

グラフの左側からワークシートの原点までの距離 (ポイント単位)。

setLeft(left: number): void;

パラメーター

left: number

戻り値

void

setName(name)

グラフオブジェクトの名前を指定します。

setName(name: string): void;

パラメーター

name: string

戻り値

void

例

/**
 * 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");
}

setPlotBy(plotBy)

列や行がグラフのデータ系列として使用される方法を指定します。

setPlotBy(plotBy: ChartPlotBy): void;

パラメーター

plotBy: ExcelScript.ChartPlotBy

戻り値

void

例

/**
 * This sample performs the "Switch Row/Column" action on a chart named "ColumnClusteredChart".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get an existing chart named "ColumnClusteredChart".
  let columnClusteredChart = selectedSheet.getChart("ColumnClusteredChart");
  
  // Switch the row and column for the chart's data source.
  if (columnClusteredChart.getPlotBy() === ExcelScript.ChartPlotBy.columns) {
    // If the chart is grouped by columns, switch it to rows.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.rows);
  } else {
    // If the chart is grouped by rows, switch it to columns.
    columnClusteredChart.setPlotBy(ExcelScript.ChartPlotBy.columns);
  }
}

setPlotVisibleOnly(plotVisibleOnly)

true の場合、可視セルだけがプロットされます。 false の場合、可視セルと非表示セルの両方がプロットされます。

setPlotVisibleOnly(plotVisibleOnly: boolean): void;

パラメーター

plotVisibleOnly: boolean

戻り値

void

setPosition(startCell, endCell)

ワークシート上のセルを基準にしてグラフを配置します。

setPosition(startCell: Range | string, endCell?: Range | string): void;

パラメーター

startCell: ExcelScript.Range | string

開始セル。これは、グラフの移動先です。開始セルは、ユーザーの右から左への表示の設定に応じて、左上のセルか、右上のセルとなります。

endCell: ExcelScript.Range | string

省略可能。終了セル。指定されている場合、グラフの幅と高さは、このセルまたは範囲を完全にカバーするように設定されます。

戻り値

void

例

/**
 * 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");
}

setSeriesNameLevel(seriesNameLevel)

ソース系列名のレベルを参照するグラフ系列名レベル列挙定数を指定します。

setSeriesNameLevel(seriesNameLevel: number): void;

パラメーター

seriesNameLevel: number

戻り値

void

setShowAllFieldButtons(showAllFieldButtons)

ピボットグラフにすべてのフィールドボタンを表示するかどうかを指定します。

setShowAllFieldButtons(showAllFieldButtons: boolean): void;

パラメーター

showAllFieldButtons: boolean

戻り値

void

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum: boolean): void;

パラメーター

showDataLabelsOverMaximum: boolean

戻り値

void

setStyle(style)

グラフのグラフスタイルを指定します。

setStyle(style: number): void;

パラメーター

style: number

戻り値

void

setTop(top)

オブジェクトの上端から行 1 の上端 (ワークシート上) またはグラフ領域 (グラフ上) の上端までの距離をポイント単位で指定します。

setTop(top: number): void;

パラメーター

top: number

戻り値

void

setWidth(width)

グラフオブジェクトの幅をポイント単位で指定します。

setWidth(width: number): void;

パラメーター

width: number

戻り値

void

次の方法で共有

ExcelScript.Chart interface

メソッド

メソッドの詳細

activate()

戻り値

addChartSeries(name, index)

パラメーター

戻り値

例

delete()

戻り値

getAxes()

戻り値

getCategoryLabelLevel()

戻り値

getChartType()

戻り値

getDataLabels()

戻り値

getDataTable()

戻り値

getDisplayBlanksAs()

戻り値

getFormat()

戻り値

getHeight()

戻り値

getId()

戻り値

getImage(width, height, fittingMode)

パラメーター

戻り値

例

getLeft()

戻り値

getLegend()

戻り値

getName()

戻り値

getPivotOptions()

戻り値

getPlotArea()

戻り値

getPlotBy()

戻り値

例

getPlotVisibleOnly()

戻り値

getSeries()

戻り値

例

getSeriesNameLevel()

戻り値

getShowAllFieldButtons()

戻り値

getShowDataLabelsOverMaximum()

戻り値

getStyle()

戻り値

getTitle()

戻り値

getTop()

戻り値

getWidth()

戻り値

getWorksheet()

戻り値

setCategoryLabelLevel(categoryLabelLevel)

パラメーター

戻り値

setChartType(chartType)

パラメーター

戻り値

setData(sourceData, seriesBy)

パラメーター

戻り値

setDisplayBlanksAs(displayBlanksAs)

パラメーター

戻り値