ExcelScript.Chart interface

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

メソッド

activate()

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

addChartSeries(name, index)

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

delete()

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

getAxes()

グラフの軸を表します。

getCategoryLabelLevel()

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

getChartType()

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

getDataLabels()

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

getDisplayBlanksAs()

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

getFormat()

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

getHeight()

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

getId()

グラフの一意の ID。

getImage(width, height, fittingMode)

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

getLeft()

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

getLegend()

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

getName()

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

getPivotOptions()

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

getPlotArea()

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

getPlotBy()

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

getPlotVisibleOnly()

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

getSeries()

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

getSeriesNameLevel()

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

getShowAllFieldButtons()

すべてのフィールド ボタンを 1 つのウィンドウに表示するかどうかをピボットグラフ。

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)

すべてのフィールド ボタンを 1 つのウィンドウに表示するかどうかをピボットグラフ。

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 を起点とする番号になります。

戻り値

delete()

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

delete(): void;

戻り値

void

getAxes()

グラフの軸を表します。

getAxes(): ChartAxes;

戻り値

getCategoryLabelLevel()

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

getCategoryLabelLevel(): number;

戻り値

number

getChartType()

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

getChartType(): ChartType;

戻り値

getDataLabels()

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

getDataLabels(): ChartDataLabels;

戻り値

getDisplayBlanksAs()

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

getDisplayBlanksAs(): ChartDisplayBlanksAs;

戻り値

getFormat()

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

getFormat(): 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

getLeft()

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

getLeft(): number;

戻り値

number

getLegend()

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

getLegend(): ChartLegend;

戻り値

getName()

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

getName(): string;

戻り値

string

getPivotOptions()

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

getPivotOptions(): ChartPivotOptions;

戻り値

getPlotArea()

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

getPlotArea(): ChartPlotArea;

戻り値

getPlotBy()

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

getPlotBy(): 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[];

戻り値

/**
 * 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()

すべてのフィールド ボタンを 1 つのウィンドウに表示するかどうかをピボットグラフ。

getShowAllFieldButtons(): boolean;

戻り値

boolean

getShowDataLabelsOverMaximum()

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

getShowDataLabelsOverMaximum(): boolean;

戻り値

boolean

getStyle()

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

getStyle(): number;

戻り値

number

getTitle()

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

getTitle(): ChartTitle;

戻り値

getTop()

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

getTop(): number;

戻り値

number

getWidth()

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

getWidth(): number;

戻り値

number

getWorksheet()

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

getWorksheet(): Worksheet;

戻り値

setCategoryLabelLevel(categoryLabelLevel)

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

setCategoryLabelLevel(categoryLabelLevel: number): void;

パラメーター

categoryLabelLevel

number

戻り値

void

setChartType(chartType)

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

setChartType(chartType: ChartType): void;

パラメーター

戻り値

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;

パラメーター

戻り値

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;

パラメーター

戻り値

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)

すべてのフィールド ボタンを 1 つのウィンドウに表示するかどうかをピボットグラフ。

setShowAllFieldButtons(showAllFieldButtons: boolean): void;

パラメーター

showAllFieldButtons

boolean

戻り値

void

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)

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

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