Excel.ChartDataLabel class

グラフのポイントのデータラベルを表します。Represents the data label of a chart point.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

Extends

プロパティ

autoText

データ ラベルでコンテキストに基づく適切なテキストを自動的に生成するかどうかを表すブール値。Boolean value representing if data label automatically generates appropriate text based on context.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

format

グラフのデータ ラベルの書式設定を表します。Represents the format of chart data label.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

formula

A1 スタイルの表記法を使用するグラフのデータ ラベルの数式を表す文字列値。String value that represents the formula of chart data label using A1-style notation.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

height

グラフのデータ ラベルの高さ (ポイント数) を返します。Returns the height, in points, of the chart data label. 読み取り専用です。Read-only. グラフのデータ ラベルが表示されない場合は null 値となります。Null if chart data label is not visible.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

horizontalAlignment

グラフのデータ ラベルの水平方向の配置を表します。Represents the horizontal alignment for chart data label. 詳細については、「ChartTextHorizontalAlignment」を参照してください。See Excel.ChartTextHorizontalAlignment for details. このプロパティは、データラベルの TextOrientation が90、-90、または180の場合にのみ有効です。This property is valid only when TextOrientation of data label is 90, -90 or 180.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

left

グラフのデータ ラベルの左端からグラフ エリアの左端までの距離 (ポイント数) を表します。Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. グラフのデータ ラベルが表示されない場合は null 値となります。Null if chart data label is not visible.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

linkNumberFormat

(セル内で変更されたときにラベルの数値形式が変わるように) 数値形式がセルにリンクされているかどうかを表すブール値です。Boolean value representing if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

numberFormat

データ ラベルの書式コードを表す文字列値。String value that represents the format code for data label.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

position

データ ラベルの位置を表す DataLabelPosition 値。DataLabelPosition value that represents the position of the data label. 詳細については、「ChartDataLabelPosition」を参照してください。See Excel.ChartDataLabelPosition for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

separator

グラフのデータ ラベルに使用される区切り文字を表す文字列。String representing the separator used for the data label on a chart.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showBubbleSize

データ ラベルのバブルのサイズを表示または非表示にするかを表すブール値。Boolean value representing if the data label bubble size is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showCategoryName

データ ラベルのカテゴリ名を表示するか非表示にするかを表すブール値。Boolean value representing if the data label category name is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showLegendKey

データ ラベルの凡例マーカーを表示するか非表示にするかを表すブール値。Boolean value representing if the data label legend key is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showPercentage

データ ラベルのパーセンテージを表示するか非表示にするかを表すブール値。Boolean value representing if the data label percentage is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showSeriesName

データ ラベルの系列名を表示するか非表示にするかを表すブール値。Boolean value representing if the data label series name is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showValue

データ ラベルの値を表示するか非表示にするかを表すブール値。Boolean value representing if the data label value is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

text

グラフのデータ ラベルのテキストを表す文字列。String representing the text of the data label on a chart.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

textOrientation

グラフのデータ ラベルのテキストの向きを表します。Represents the text orientation of chart data label. 値は -90 から 90 の範囲内の整数か、縦書きテキストの場合は 180 でなければなりません。The value should be an integer either from -90 to 90, or 180 for vertically-oriented text.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

top

グラフのデータ ラベルの上端からグラフ エリアの上端までの距離 (ポイント数) を表します。Represents the distance, in points, from the top edge of chart data label to the top of chart area. グラフのデータ ラベルが表示されない場合は null 値となります。Null if chart data label is not visible.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

verticalAlignment

グラフのデータ ラベルの垂直方向の配置を表します。Represents the vertical alignment of chart data label. 詳細については、「Excel Charttext縦書きの配置」を参照してください。See Excel.ChartTextVerticalAlignment for details. このプロパティは、データラベルの TextOrientation が0の場合にのみ有効です。This property is valid only when TextOrientation of data label is 0.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

width

グラフのデータ ラベルの幅 (ポイント数) を返します。Returns the width, in points, of the chart data label. 読み取り専用です。Read-only. グラフのデータ ラベルが表示されない場合は null 値となります。Null if chart data label is not visible.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

メソッド

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の ChartDataLabel オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.ChartDataLabelData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartDataLabel object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartDataLabelData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

autoText

データ ラベルでコンテキストに基づく適切なテキストを自動的に生成するかどうかを表すブール値。Boolean value representing if data label automatically generates appropriate text based on context.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

autoText: boolean;

プロパティ値

boolean

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

format

グラフのデータ ラベルの書式設定を表します。Represents the format of chart data label.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly format: Excel.ChartDataLabelFormat;

プロパティ値

formula

A1 スタイルの表記法を使用するグラフのデータ ラベルの数式を表す文字列値。String value that represents the formula of chart data label using A1-style notation.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

formula: string;

プロパティ値

string

height

グラフのデータ ラベルの高さ (ポイント数) を返します。Returns the height, in points, of the chart data label. 読み取り専用です。Read-only. グラフのデータ ラベルが表示されない場合は null 値となります。Null if chart data label is not visible.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly height: number;

プロパティ値

number

horizontalAlignment

グラフのデータ ラベルの水平方向の配置を表します。Represents the horizontal alignment for chart data label. 詳細については、「ChartTextHorizontalAlignment」を参照してください。See Excel.ChartTextHorizontalAlignment for details. このプロパティは、データラベルの TextOrientation が90、-90、または180の場合にのみ有効です。This property is valid only when TextOrientation of data label is 90, -90 or 180.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

プロパティ値

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

left

グラフのデータ ラベルの左端からグラフ エリアの左端までの距離 (ポイント数) を表します。Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. グラフのデータ ラベルが表示されない場合は null 値となります。Null if chart data label is not visible.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

left: number;

プロパティ値

number

linkNumberFormat

(セル内で変更されたときにラベルの数値形式が変わるように) 数値形式がセルにリンクされているかどうかを表すブール値です。Boolean value representing if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

linkNumberFormat: boolean;

プロパティ値

boolean

numberFormat

データ ラベルの書式コードを表す文字列値。String value that represents the format code for data label.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

numberFormat: string;

プロパティ値

string

position

データ ラベルの位置を表す DataLabelPosition 値。DataLabelPosition value that represents the position of the data label. 詳細については、「ChartDataLabelPosition」を参照してください。See Excel.ChartDataLabelPosition for details.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";

プロパティ値

Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"

separator

グラフのデータ ラベルに使用される区切り文字を表す文字列。String representing the separator used for the data label on a chart.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

separator: string;

プロパティ値

string

showBubbleSize

データ ラベルのバブルのサイズを表示または非表示にするかを表すブール値。Boolean value representing if the data label bubble size is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showBubbleSize: boolean;

プロパティ値

boolean

showCategoryName

データ ラベルのカテゴリ名を表示するか非表示にするかを表すブール値。Boolean value representing if the data label category name is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showCategoryName: boolean;

プロパティ値

boolean

showLegendKey

データ ラベルの凡例マーカーを表示するか非表示にするかを表すブール値。Boolean value representing if the data label legend key is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showLegendKey: boolean;

プロパティ値

boolean

showPercentage

データ ラベルのパーセンテージを表示するか非表示にするかを表すブール値。Boolean value representing if the data label percentage is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showPercentage: boolean;

プロパティ値

boolean

showSeriesName

データ ラベルの系列名を表示するか非表示にするかを表すブール値。Boolean value representing if the data label series name is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showSeriesName: boolean;

プロパティ値

boolean

showValue

データ ラベルの値を表示するか非表示にするかを表すブール値。Boolean value representing if the data label value is visible or not.

[API セット: excelapi 1.7][ API set: ExcelApi 1.7 ]

showValue: boolean;

プロパティ値

boolean

text

グラフのデータ ラベルのテキストを表す文字列。String representing the text of the data label on a chart.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

text: string;

プロパティ値

string

textOrientation

グラフのデータ ラベルのテキストの向きを表します。Represents the text orientation of chart data label. 値は -90 から 90 の範囲内の整数か、縦書きテキストの場合は 180 でなければなりません。The value should be an integer either from -90 to 90, or 180 for vertically-oriented text.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

textOrientation: number;

プロパティ値

number

top

グラフのデータ ラベルの上端からグラフ エリアの上端までの距離 (ポイント数) を表します。Represents the distance, in points, from the top edge of chart data label to the top of chart area. グラフのデータ ラベルが表示されない場合は null 値となります。Null if chart data label is not visible.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

top: number;

プロパティ値

number

verticalAlignment

グラフのデータ ラベルの垂直方向の配置を表します。Represents the vertical alignment of chart data label. 詳細については、「Excel Charttext縦書きの配置」を参照してください。See Excel.ChartTextVerticalAlignment for details. このプロパティは、データラベルの TextOrientation が0の場合にのみ有効です。This property is valid only when TextOrientation of data label is 0.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

プロパティ値

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

width

グラフのデータ ラベルの幅 (ポイント数) を返します。Returns the width, in points, of the chart data label. 読み取り専用です。Read-only. グラフのデータ ラベルが表示されない場合は null 値となります。Null if chart data label is not visible.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly width: number;

プロパティ値

number

メソッドの詳細

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel;

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.ChartDataLabel-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.ChartDataLabel - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.ChartDataLabel-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.ChartDataLabel - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartDataLabel-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartDataLabel - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNamesAndPaths
{ select?: string; expand?: string; }

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.ChartDataLabelUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.ChartDataLabel): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ChartDataLabel): void;

パラメーター

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の ChartDataLabel オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.ChartDataLabelData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartDataLabel object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartDataLabelData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartDataLabelData;

戻り値