Excel.ChartAxis class

指定した軸ティック ラベルの配置を指定します。 詳細については、「 Excel.ChartTextHorizontalAlignment 」を参照してください。

alignment: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

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

readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

指定したカテゴリ軸の基本単位を指定します。

baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

カテゴリ軸の種類を指定します。

categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

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

context: RequestContext;

プロパティ値

カスタム軸の表示単位の値を指定します。 このプロパティを設定するには、 SetCustomDisplayUnit(double) メソッドを使用してください。

readonly customDisplayUnit: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

軸の表示単位を表します。 詳細は「Excel.ChartAxisDisplayUnit」をご覧ください。

displayUnit: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let chart = sheet.charts.getItemAt(0);
    let categoryAxis = chart.axes.categoryAxis;
    let valueAxis = chart.axes.valueAxis;

    // Load to get display unit.
    valueAxis.load("displayUnit");

    await context.sync();

    console.log("The vertical axis display unit is: " + valueAxis.displayUnit);
});

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

readonly format: Excel.ChartAxisFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

グラフ軸の高さをポイント単位で指定します。 軸が表示されていない場合は、 null を返します。

readonly height: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

値軸がカテゴリ軸とカテゴリの間で交差するかどうかを指定します。

isBetweenCategories: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

軸の左端からグラフ領域の左側までの距離をポイント単位で指定します。 軸が表示されていない場合は、 null を返します。

readonly left: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

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

linkNumberFormat: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

対数スケールを使用する場合の対数の底を指定します。

logBase: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

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

readonly majorGridlines: Excel.ChartGridlines;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

majorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

categoryType プロパティが dateAxis に設定されている場合に、カテゴリ軸のメジャー単位スケール値を指定します。

majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

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

majorUnit: any;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

maximum: any;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

minimum: any;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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

readonly minorGridlines: Excel.ChartGridlines;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

指定した軸の補助目盛りの種類を指定します。 詳細は「Excel.ChartAxisTickMark」をご覧ください。

minorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

categoryType プロパティが dateAxis に設定されている場合に、カテゴリ軸の小単位スケール値を指定します。

minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

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

minorUnit: any;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

軸がマルチレベルかどうかを指定します。

multiLevel: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

軸目盛ラベルの書式コードを指定します。

numberFormat: string;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

ラベルのレベル間の距離と、最初のレベルと軸線の間の距離を指定します。 値は 0 から 1000 の範囲内でなければなりません。

offset: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

他の軸が交差する指定した軸の位置を指定します。 詳細は「Excel.ChartAxisPosition」をご覧ください。

position: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom";

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

他の軸が交差する軸の位置を指定します。 このプロパティを設定するには、 SetPositionAt(double) メソッドを使用する必要があります。

readonly positionAt: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

Excel でデータ ポイントを最後から最初にプロットするかどうかを指定します。

reversePlotOrder: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

値軸スケールの種類を指定します。 詳細は「Excel.ChartAxisScaleType」をご覧ください。

scaleType: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

軸の表示単位ラベルを表示するかどうかを指定します。

showDisplayUnitLabel: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    let chart = sheet.charts.getItemAt(0);
    let axis = chart.axes.valueAxis;

    // Remove display unit.
    axis.showDisplayUnitLabel = false;

    await context.sync();
});

グラフ軸目盛ラベルのテキストの向きを示す角度を指定します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。

textOrientation: any;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

指定された軸の目盛ラベルの位置を指定します。 詳細は「Excel.ChartAxisTickLabelPosition」をご覧ください。

tickLabelPosition: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

目盛ラベル間のカテゴリまたは系列の数を指定します。 1 から 31999 の範囲内で値を設定できます。自動的に設定する場合は、空の文字列にします。 戻り値は常に数値です。

tickLabelSpacing: any;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

目盛りの間のカテゴリまたは系列の数を指定します。

tickMarkSpacing: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

軸タイトルを表します。

readonly title: Excel.ChartAxisTitle;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

軸の上端からグラフ領域の上端までの距離をポイント単位で指定します。 軸が表示されていない場合は、 null を返します。

readonly top: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

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

readonly type: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

軸が表示されるかどうかを指定します。

visible: boolean;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

グラフ軸の幅をポイント単位で指定します。 軸が表示されていない場合は、 null を返します。

readonly width: number;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

例

// 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);
});

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

set(properties: Excel.ChartAxis): void;

パラメーター

戻り値

指定した軸のすべてのカテゴリ名を設定します。

setCategoryNames(sourceData: Range): void;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.7 ]

軸の表示単位をカスタム値に設定します。

setCustomDisplayUnit(value: number): void;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.7 ]

他の軸が交差する指定した軸の位置を設定します。

setPositionAt(value: number): void;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.8 ]

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

toJSON(): Excel.Interfaces.ChartAxisData;

戻り値