Excel.ChartAxes class

グラフの軸を表します。

Extends

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

categoryAxis

グラフの項目軸を表します。

context

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

seriesAxis

3-D グラフの系列軸を表します。

valueAxis

軸の数値軸を表します。

メソッド

getItem(type, group)

種類とグループで識別された特定の軸を返します。

getItem(typeString, groupString)

種類とグループで識別された特定の軸を返します。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

toJSON()

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

プロパティの詳細

categoryAxis

グラフの項目軸を表します。

readonly categoryAxis: Excel.ChartAxis;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

context

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

context: RequestContext;

プロパティ値

seriesAxis

3-D グラフの系列軸を表します。

readonly seriesAxis: Excel.ChartAxis;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

valueAxis

軸の数値軸を表します。

readonly valueAxis: Excel.ChartAxis;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

// Set the maximum, minimum, majorUnit, minorUnit of valueAxis.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.axes.valueAxis.maximum = 5;
    chart.axes.valueAxis.minimum = 0;
    chart.axes.valueAxis.majorUnit = 1;
    chart.axes.valueAxis.minorUnit = 0.2;
    await context.sync();

    console.log("Axis Settings Changed");
});

メソッドの詳細

getItem(type, group)

種類とグループで識別された特定の軸を返します。

getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup): Excel.ChartAxis;

パラメーター

type
Excel.ChartAxisType

軸の種類を指定します。 詳細は「Excel.ChartAxisType」をご覧ください。

group
Excel.ChartAxisGroup

省略可能。 軸のグループを指定します。 詳細は「Excel.ChartAxisGroup」をご覧ください。

戻り値

注釈

[ API セット: ExcelApi 1.7 ]

getItem(typeString, groupString)

種類とグループで識別された特定の軸を返します。

getItem(typeString: "Invalid" | "Category" | "Value" | "Series", groupString?: "Primary" | "Secondary"): Excel.ChartAxis;

パラメーター

typeString

"Invalid" | "Category" | "Value" | "Series"

軸の種類を指定します。 詳細は「Excel.ChartAxisType」をご覧ください。

groupString

"Primary" | "Secondary"

省略可能。 軸のグループを指定します。 詳細は「Excel.ChartAxisGroup」をご覧ください。

戻り値

注釈

[ API セット: ExcelApi 1.7 ]

load(options)

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

load(options?: Excel.Interfaces.ChartAxesLoadOptions): Excel.ChartAxes;

パラメーター

options
Excel.Interfaces.ChartAxesLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.ChartAxesUpdateData

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

options
OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.ChartAxes): void;

パラメーター

properties
Excel.ChartAxes

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartAxesData;

戻り値