Excel.ChartTrendlineLabel class

このオブジェクトは、グラフの近似曲線ラベル オブジェクトの属性を表します。

Extends

注釈

[ API セット: ExcelApi 1.8 ]

プロパティ

autoText

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

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

format

グラフの近似曲線ラベルの形式。

formula

A1 スタイルの表記を使用してグラフの近似曲線ラベルの数式を表す文字列値。

height

グラフの近似曲線ラベルの高さ (ポイント数) を返します。 値は、 null グラフの近似曲線ラベルが表示されない場合です。

horizontalAlignment

グラフの近似曲線ラベルの水平方向の配置を表します。 詳細は「Excel.ChartTextHorizontalAlignment」をご覧ください。 このプロパティは、近似曲線ラベルが -90、90、または 180 の場合 TextOrientation にのみ有効です。

left

グラフの近似曲線ラベルの左端からグラフ領域の左端までの距離をポイント単位で表します。 値は、 null グラフの近似曲線ラベルが表示されない場合です。

linkNumberFormat

数値形式をセルにリンクするかどうかを指定します (セル内で数値書式が変更されたときにラベルが変更されるようにします)。

numberFormat

近似曲線ラベルの書式コードを表す文字列値。

text

グラフの近似曲線ラベルのテキストを表す文字列。

textOrientation

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

top

グラフの近似曲線ラベルの上端からグラフ領域の上端までの距離をポイント単位で表します。 値は、 null グラフの近似曲線ラベルが表示されない場合です。

verticalAlignment

グラフの近似曲線ラベルの垂直方向の配置を表します。 詳細は「Excel.ChartTextVerticalAlignment」をご覧ください。 このプロパティは、近似曲線ラベルが 0 の場合 TextOrientation にのみ有効です。

width

グラフの近似曲線ラベルの幅 (ポイント数) を返します。 値は、 null グラフの近似曲線ラベルが表示されない場合です。

メソッド

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

toJSON()

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.ChartTrendlineLabel オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.ChartTrendlineLabelData型指定) を返します。

プロパティの詳細

autoText

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

autoText: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

format

グラフの近似曲線ラベルの形式。

readonly format: Excel.ChartTrendlineLabelFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

formula

A1 スタイルの表記を使用してグラフの近似曲線ラベルの数式を表す文字列値。

formula: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.8 ]

height

グラフの近似曲線ラベルの高さ (ポイント数) を返します。 値は、 null グラフの近似曲線ラベルが表示されない場合です。

readonly height: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

horizontalAlignment

グラフの近似曲線ラベルの水平方向の配置を表します。 詳細は「Excel.ChartTextHorizontalAlignment」をご覧ください。 このプロパティは、近似曲線ラベルが -90、90、または 180 の場合 TextOrientation にのみ有効です。

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

プロパティ値

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

注釈

[ API セット: ExcelApi 1.8 ]

left

グラフの近似曲線ラベルの左端からグラフ領域の左端までの距離をポイント単位で表します。 値は、 null グラフの近似曲線ラベルが表示されない場合です。

left: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

linkNumberFormat

数値形式をセルにリンクするかどうかを指定します (セル内で数値書式が変更されたときにラベルが変更されるようにします)。

linkNumberFormat: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

numberFormat

近似曲線ラベルの書式コードを表す文字列値。

numberFormat: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.8 ]

text

グラフの近似曲線ラベルのテキストを表す文字列。

text: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.8 ]

textOrientation

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

textOrientation: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

top

グラフの近似曲線ラベルの上端からグラフ領域の上端までの距離をポイント単位で表します。 値は、 null グラフの近似曲線ラベルが表示されない場合です。

top: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

verticalAlignment

グラフの近似曲線ラベルの垂直方向の配置を表します。 詳細は「Excel.ChartTextVerticalAlignment」をご覧ください。 このプロパティは、近似曲線ラベルが 0 の場合 TextOrientation にのみ有効です。

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

プロパティ値

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

注釈

[ API セット: ExcelApi 1.8 ]

width

グラフの近似曲線ラベルの幅 (ポイント数) を返します。 値は、 null グラフの近似曲線ラベルが表示されない場合です。

readonly width: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

メソッドの詳細

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.ChartTrendlineLabelLoadOptions): Excel.ChartTrendlineLabel;

パラメーター

options
Excel.Interfaces.ChartTrendlineLabelLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

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

パラメーター

propertyNamesAndPaths

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

propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

properties
Excel.Interfaces.ChartTrendlineLabelUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.ChartTrendlineLabel): void;

パラメーター

戻り値

void

toJSON()

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の Excel.ChartTrendlineLabel オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.ChartTrendlineLabelData型指定) を返します。

toJSON(): Excel.Interfaces.ChartTrendlineLabelData;

戻り値