ExcelScript.ChartDataLabels interface

データ ラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。

getAutoText(): boolean;

戻り値

塗りつぶしとフォントの書式設定を含むグラフ データ ラベルの形式を指定します。

getFormat(): ChartDataLabelFormat;

戻り値

データ ラベルの幾何学的図形の種類を指定します。 詳細については、ExcelScript.GeometricShapeTypeを参照してください。 データ ラベルが幾何学的図形でない場合、値は null されます。

getGeometricShapeType(): GeometricShapeType;

戻り値

グラフ データ ラベルの水平方向の配置を指定します。 詳細は「ExcelScript.ChartTextHorizontalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が 0 の場合にのみ有効です。

getHorizontalAlignment(): ChartTextHorizontalAlignment;

戻り値

データ ラベルの引き出し線を表す オブジェクトを取得します。

getLeaderLines(): ChartLeaderLines;

戻り値

数値形式をセルにリンクするかどうかを指定します。 true した場合、セル内で数値形式が変更されるとラベルが変更されます。

getLinkNumberFormat(): boolean;

戻り値

データ ラベルの書式コードを指定します。

getNumberFormat(): string;

戻り値

データ ラベルの位置を表す値。 詳細は「ExcelScript.ChartDataLabelPosition」をご覧ください。

getPosition(): ChartDataLabelPosition;

戻り値

グラフのデータ ラベルに使用される区切り文字を表す文字列を設定します。

getSeparator(): string;

戻り値

データ ポイントにテール アンカーがアタッチされた吹き出しとしてデータ ラベルを表示するかどうかを指定します。 true 場合、吹き出しは次のいずれかの値になります。"AccentCallout1"、"AccentCallout2"、"BorderCallout1"、"BorderCallout2"、"WedgeRectCallout"、"WedgeRRectCallout" または "WedgeEllipseCallout" です。

getShowAsStickyCallout(): boolean;

戻り値

データ ラベルのバブル サイズを表示するかどうかを指定します。

getShowBubbleSize(): boolean;

戻り値

データ ラベル カテゴリ名を表示するかどうかを指定します。

getShowCategoryName(): boolean;

戻り値

データ ラベルの引き出し線を表示するかどうかを指定します。 true 引出し線が表示される場合。それ以外の場合は、 false。

getShowLeaderLines(): boolean;

戻り値

データ ラベルの凡例キーを表示するかどうかを指定します。

getShowLegendKey(): boolean;

戻り値

データ ラベルの割合を表示するかどうかを指定します。

getShowPercentage(): boolean;

戻り値

データ ラベル系列名を表示するかどうかを指定します。

getShowSeriesName(): boolean;

戻り値

データ ラベルの値を表示するかどうかを指定します。

getShowValue(): boolean;

戻り値

データ ラベルのテキストの向きを示す角度を表します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。

getTextOrientation(): number;

戻り値

グラフのデータ ラベルの垂直方向の配置を表します。 詳細は「ExcelScript.ChartTextVerticalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が -90、90、または 180 の場合にのみ有効です。

getVerticalAlignment(): ChartTextVerticalAlignment;

戻り値

データ ラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。

setAutoText(autoText: boolean): void;

パラメーター

戻り値

データ ラベルの幾何学的図形の種類を指定します。 詳細については、ExcelScript.GeometricShapeTypeを参照してください。 データ ラベルが幾何学的図形でない場合、値は null されます。

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

パラメーター

戻り値

グラフ データ ラベルの水平方向の配置を指定します。 詳細は「ExcelScript.ChartTextHorizontalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が 0 の場合にのみ有効です。

setHorizontalAlignment(
            horizontalAlignment: ChartTextHorizontalAlignment
        ): void;

パラメーター

戻り値

数値形式をセルにリンクするかどうかを指定します。 true した場合、セル内で数値形式が変更されるとラベルが変更されます。

setLinkNumberFormat(linkNumberFormat: boolean): void;

パラメーター

戻り値

データ ラベルの書式コードを指定します。

setNumberFormat(numberFormat: string): void;

パラメーター

戻り値

データ ラベルの位置を表す値。 詳細は「ExcelScript.ChartDataLabelPosition」をご覧ください。

setPosition(position: ChartDataLabelPosition): void;

パラメーター

戻り値

例

/**
 * This sample sets the position of data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the data label position to best fit.
  const series = chart.getSeries()[0];
  series.getDataLabels().setPosition(ExcelScript.ChartDataLabelPosition.bestFit);
}

グラフのデータ ラベルに使用される区切り文字を表す文字列を設定します。

setSeparator(separator: string): void;

パラメーター

戻り値

データ ラベルのバブル サイズを表示するかどうかを指定します。

setShowBubbleSize(showBubbleSize: boolean): void;

パラメーター

戻り値

データ ラベル カテゴリ名を表示するかどうかを指定します。

setShowCategoryName(showCategoryName: boolean): void;

パラメーター

戻り値

例

/**
 * This sample shows category names in data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Show category names in the data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowCategoryName(true);
}

データ ラベルの引き出し線を表示するかどうかを指定します。 true 引出し線が表示される場合。それ以外の場合は、 false。

setShowLeaderLines(showLeaderLines: boolean): void;

パラメーター

戻り値

例

/**
 * This sample enables leader lines for data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Enable leader lines.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowLeaderLines(true);
}

データ ラベルの凡例キーを表示するかどうかを指定します。

setShowLegendKey(showLegendKey: boolean): void;

パラメーター

戻り値

データ ラベルの割合を表示するかどうかを指定します。

setShowPercentage(showPercentage: boolean): void;

パラメーター

戻り値

例

/**
 * This sample shows percentages in data labels.
 * This assumes the active worksheet has a pie chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Show percentages in the data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowPercentage(true);
}

データ ラベル系列名を表示するかどうかを指定します。

setShowSeriesName(showSeriesName: boolean): void;

パラメーター

戻り値

例

/**
 * This sample controls series name visibility in data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Hide the series name in data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowSeriesName(false);
}

データ ラベルの値を表示するかどうかを指定します。

setShowValue(showValue: boolean): void;

パラメーター

戻り値

例

/**
 * This sample shows values in data labels.
 * This assumes the active worksheet has a chart with data labels enabled.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Show values in the data labels.
  const series = chart.getSeries()[0];
  series.getDataLabels().setShowValue(true);
}

データ ラベルのテキストの向きを示す角度を表します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。

setTextOrientation(textOrientation: number): void;

パラメーター

戻り値

グラフのデータ ラベルの垂直方向の配置を表します。 詳細は「ExcelScript.ChartTextVerticalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が -90、90、または 180 の場合にのみ有効です。

setVerticalAlignment(
            verticalAlignment: ChartTextVerticalAlignment
        ): void;

パラメーター

戻り値