Excel.ChartAxis class

グラフの 1 つの軸を表します。

Extends

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

context

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

format

線とフォントの書式設定を含むグラフ オブジェクトの書式設定を表します。

majorGridlines

指定した軸の目盛線を表す オブジェクトを返します。

majorUnit

2 つの大きい目盛の間隔を表します。 数値の値または空の文字列を設定できます。 戻り値は常に数値です。

maximum

数値軸の最大値を表します。 数値の値または空の文字列を設定できます (軸の値が自動の場合)。 戻り値は常に数値です。

minimum

数値軸の最小値を表します。 数値の値または空の文字列を設定できます (軸の値が自動の場合)。 戻り値は常に数値です。

minorGridlines

指定した軸の補助目盛線を表す オブジェクトを返します。

minorUnit

2 つの小さい目盛の間隔を表します。 数値の値または空の文字列を設定できます (軸の値が自動の場合)。 戻り値は常に数値です。

title

軸タイトルを表します。

メソッド

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.ChartAxis オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.ChartAxisData型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

format

線とフォントの書式設定を含むグラフ オブジェクトの書式設定を表します。

readonly format: Excel.ChartAxisFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

majorGridlines

指定した軸の目盛線を表す オブジェクトを返します。

readonly majorGridlines: Excel.ChartGridlines;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

majorUnit

2 つの大きい目盛の間隔を表します。 数値の値または空の文字列を設定できます。 戻り値は常に数値です。

majorUnit: any;

プロパティ値

any

注釈

[ API セット: ExcelApi 1.1 ]

maximum

数値軸の最大値を表します。 数値の値または空の文字列を設定できます (軸の値が自動の場合)。 戻り値は常に数値です。

maximum: any;

プロパティ値

any

注釈

[ API セット: ExcelApi 1.1 ]

minimum

数値軸の最小値を表します。 数値の値または空の文字列を設定できます (軸の値が自動の場合)。 戻り値は常に数値です。

minimum: any;

プロパティ値

any

注釈

[ API セット: ExcelApi 1.1 ]

minorGridlines

指定した軸の補助目盛線を表す オブジェクトを返します。

readonly minorGridlines: Excel.ChartGridlines;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

minorUnit

2 つの小さい目盛の間隔を表します。 数値の値または空の文字列を設定できます (軸の値が自動の場合)。 戻り値は常に数値です。

minorUnit: any;

プロパティ値

any

注釈

[ API セット: ExcelApi 1.1 ]

title

軸タイトルを表します。

readonly title: Excel.ChartAxisTitle;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis;

パラメーター

options
Excel.Interfaces.ChartAxisLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

// Get the maximum of Chart Axis from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const axis = chart.axes.valueAxis;
    axis.load('maximum');
    await context.sync();

    console.log(axis.maximum);
});

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.ChartAxisUpdateData

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

options
OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.ChartAxis): void;

パラメーター

properties
Excel.ChartAxis

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartAxisData;

戻り値